Skip to content

Commit a326eb7

Browse files
simplify docs editing process
1 parent 350c50e commit a326eb7

1 file changed

Lines changed: 9 additions & 18 deletions

File tree

doc/developer.contributing.rst

Lines changed: 9 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Testing your changes
6969
By default, pull requests on GitHub will trigger the running of Gambit's test suite using GitHub Actions.
7070
You can also run the tests locally before submitting your pull request, using `pytest`.
7171

72-
1. If you haven't already, install the test dependencies: ::
72+
1. Install the test dependencies (into the virtual environment where you installed PyGambit): ::
7373

7474
pip install -r tests/requirements.txt
7575

@@ -79,32 +79,23 @@ You can also run the tests locally before submitting your pull request, using `p
7979

8080

8181
Editing this documentation
82-
--------------------------
82+
^^^^^^^^^^^^^^^^^^^^^^^^^^
8383

84-
1. If you haven't already, clone the Gambit repository from GitHub: ::
84+
You can make changes to the documentation by editing the `.rst` files in the ``doc`` directory.
85+
Creating a pull request with your changes will automatically trigger a build of the documentation via the ReadTheDocs service, which can be viewed online.
86+
You can also build the documentation locally to preview your changes before submitting a pull request.
8587

86-
git clone https://github.com/gambitproject/gambit.git
87-
cd gambit
88-
89-
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: ::
88+
1. Install the docs dependencies (into the virtual environment where you installed PyGambit): ::
9089

91-
python -m venv docenv
92-
source docenv/bin/activate
90+
pip install -r doc/requirements.txt
9391

94-
3. Install the requirements and make the docs: ::
92+
2. Navigate to the Gambit repo and build the docs: ::
9593

96-
pip install .
9794
cd doc
98-
pip install -r requirements.txt
9995
make html # or make livehtml for live server with auto-rebuild
10096

101-
4. Open ``doc/_build/html/index.html`` in your browser to view the documentation.
102-
103-
5. Make any changes you want to the `.rst` files in the ``doc`` directory and rebuld the documentation to check your changes.
104-
105-
6. Follow the usual GitHub workflow to commit your changes and push them to the repository.
97+
3. Open ``doc/_build/html/index.html`` in your browser to view the documentation.
10698

107-
7. Core developers will review your changes and merge to the master branch, which automatically deploys the documentation via the ReadTheDocs service.
10899

109100
.. TODO: Add instructions for the GitHub workflow during contributor docs refactoring.
110101
See https://github.com/gambitproject/gambit/issues/541

0 commit comments

Comments
 (0)