Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions doc/build.rst
Original file line number Diff line number Diff line change
Expand Up @@ -144,3 +144,34 @@ 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

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
Loading