Skip to content

Commit c0bda03

Browse files
Update documentation editing instructions for clarity and completeness
1 parent 01d542d commit c0bda03

1 file changed

Lines changed: 19 additions & 7 deletions

File tree

doc/build.rst

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -145,19 +145,31 @@ using `nose2`.
145145
Once installed, simply ``import pygambit`` in your Python shell or
146146
script to get started.
147147

148-
Editing the documentation
148+
Editing this documentation
149149
--------------------------
150150

151-
Devcontainer version:
151+
1. If you haven't already, clone the Gambit repository from GitHub: ::
152152

153-
1. Open the Repo in VS Code which should automatically give you the option to open in a devcontainer.
154-
2. Open a terminal in VS Code.
155-
3. Run the following commands in the terminal: ::
153+
git clone https://github.com/gambitproject/gambit.git
154+
cd gambit
155+
156+
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: ::
157+
158+
python -m venv docenv
159+
source docenv/bin/activate
160+
161+
3. Install the requirements and make the docs: ::
156162

157-
cd /workspaces/gambit/
158163
pip install .
159164
cd doc
160165
pip install -r requirements.txt
161166
make html
162167

163-
4. Open ``doc/_build/html/index.html`` in your browser.
168+
4. Open ``doc/_build/html/index.html`` in your browser to view the documentation.
169+
170+
5. Make any changes you want to the `.rst` files in the ``doc`` directory and rebuld the documentation to check your changes.
171+
172+
6. Follow the usual GitHub workflow to commit your changes and push them to the repository.
173+
174+
.. TODO: Add instructions for the GitHub workflow during contributor docs refactoring.
175+
See https://github.com/alan-turing-institute/gambit_admin/issues/1

0 commit comments

Comments
 (0)