developer docs section

Author: edwardchalstrey1

doc/build.rst doc/developer.build.rstdoc/build.rst renamed to doc/developer.build.rst

@@ -1,5 +1,5 @@
-For developers: Building Gambit from source
-===========================================
+Building Gambit from source
+===========================
 
 This section covers instructions for building Gambit from source.
 This is for those who are interested in developing Gambit, or who
@@ -144,51 +144,3 @@ using `nose2`.
 
 Once installed, simply ``import pygambit`` in your Python shell or
 script to get started.
-
-Editing this documentation
---------------------------
-
-1. If you haven't already, clone the Gambit repository from GitHub: ::
-
-    git clone https://github.com/gambitproject/gambit.git
-    cd gambit
-
-2. Either install the docs requirements into your existing PyGambit development environment, or create a new virtual environment and install both the requirements and PyGambit there. For example, you can use `venv` to create a new environment: ::
-
-    python -m venv docenv
-    source docenv/bin/activate
-
-3. Install the requirements and make the docs: ::
-
-    pip install .
-    cd doc
-    pip install -r requirements.txt
-    make html  # or make livehtml for live server with auto-rebuild
-
-4. Open ``doc/_build/html/index.html`` in your browser to view the documentation.
-
-5. Make any changes you want to the `.rst` files in the ``doc`` directory and rebuld the documentation to check your changes.
-
-6. Follow the usual GitHub workflow to commit your changes and push them to the repository.
-
-7. Core developers will review your changes and merge to the master branch, which automatically deploys the documentation via the ReadTheDocs service.
-
-.. TODO: Add instructions for the GitHub workflow during contributor docs refactoring.
-   See https://github.com/gambitproject/gambit/issues/541
-
-Bug reports
------------
-
-In the first instance, bug reports or feature requests should be
-posted to the Gambit issue tracker, located at
-`<http://github.com/gambitproject/gambit/issues>`_.
-
-When reporting a bug, please be sure to include the following:
-
-* The version(s) of Gambit you are using.  (If possible, it is helpful
-  to know whether a bug exists in both the current stable/teaching and
-  the current development/research versions.)
-* The operating system(s) on which you encountered the bug.
-* A detailed list of steps to reproduce the bug.  Be sure to include a
-  sample game file or files if appropriate; it is often helpful to
-  simplify the game if possible.

doc/developer.contributing.rst

@@ -0,0 +1,50 @@
+Contributing to the Gambit Project
+==================================
+
+Editing this documentation
+--------------------------
+
+1. If you haven't already, clone the Gambit repository from GitHub: ::
+
+    git clone https://github.com/gambitproject/gambit.git
+    cd gambit
+
+2. Either install the docs requirements into your existing PyGambit development environment, or create a new virtual environment and install both the requirements and PyGambit there. For example, you can use `venv` to create a new environment: ::
+
+    python -m venv docenv
+    source docenv/bin/activate
+
+3. Install the requirements and make the docs: ::
+
+    pip install .
+    cd doc
+    pip install -r requirements.txt
+    make html  # or make livehtml for live server with auto-rebuild
+
+4. Open ``doc/_build/html/index.html`` in your browser to view the documentation.
+
+5. Make any changes you want to the `.rst` files in the ``doc`` directory and rebuld the documentation to check your changes.
+
+6. Follow the usual GitHub workflow to commit your changes and push them to the repository.
+
+7. Core developers will review your changes and merge to the master branch, which automatically deploys the documentation via the ReadTheDocs service.
+
+.. TODO: Add instructions for the GitHub workflow during contributor docs refactoring.
+   See https://github.com/gambitproject/gambit/issues/541
+
+Bug reports
+-----------
+
+In the first instance, bug reports or feature requests should be
+posted to the Gambit issue tracker, located at
+`<http://github.com/gambitproject/gambit/issues>`_.
+
+When reporting a bug, please be sure to include the following:
+
+* The version(s) of Gambit you are using.  (If possible, it is helpful
+  to know whether a bug exists in both the current stable/teaching and
+  the current development/research versions.)
+* The operating system(s) on which you encountered the bug.
+* A detailed list of steps to reproduce the bug.  Be sure to include a
+  sample game file or files if appropriate; it is often helpful to
+  simplify the game if possible.

doc/developer.rst

@@ -0,0 +1,13 @@
+.. _developer:
+
+
+Developer docs
+==============
+
+This section contains information for developers who want to contribute to the Gambit project, including how to build Gambit from source, how to contribute code, and how to report bugs.
+
+.. toctree::
+   :maxdepth: 2
+
+   developer.build
+   developer.contributing

doc/index.rst

@@ -67,7 +67,7 @@ construction and analysis of finite extensive and strategic games.
    tools
    gui
    samples
-   build
+   developer
    formats
    biblio