You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/developer.contributing.rst
+9-18Lines changed: 9 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -69,7 +69,7 @@ Testing your changes
69
69
By default, pull requests on GitHub will trigger the running of Gambit's test suite using GitHub Actions.
70
70
You can also run the tests locally before submitting your pull request, using `pytest`.
71
71
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): ::
73
73
74
74
pip install -r tests/requirements.txt
75
75
@@ -79,32 +79,23 @@ You can also run the tests locally before submitting your pull request, using `p
79
79
80
80
81
81
Editing this documentation
82
-
--------------------------
82
+
^^^^^^^^^^^^^^^^^^^^^^^^^^
83
83
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.
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): ::
90
89
91
-
python -m venv docenv
92
-
source docenv/bin/activate
90
+
pip install -r doc/requirements.txt
93
91
94
-
3. Install the requirements and make the docs: ::
92
+
2. Navigate to the Gambit repo and build the docs: ::
95
93
96
-
pip install .
97
94
cd doc
98
-
pip install -r requirements.txt
99
95
make html # or make livehtml for live server with auto-rebuild
100
96
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.
106
98
107
-
7. Core developers will review your changes and merge to the master branch, which automatically deploys the documentation via the ReadTheDocs service.
108
99
109
100
.. TODO: Add instructions for the GitHub workflow during contributor docs refactoring.
110
101
See https://github.com/gambitproject/gambit/issues/541
0 commit comments