From 01d542d3fccd0d1fcec7952184f85b4e6e70584d Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Tue, 5 Aug 2025 14:44:03 +0000 Subject: [PATCH 1/4] basic instructions --- doc/build.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/doc/build.rst b/doc/build.rst index 9f2307fae..f2c586b96 100644 --- a/doc/build.rst +++ b/doc/build.rst @@ -144,3 +144,20 @@ using `nose2`. Once installed, simply ``import pygambit`` in your Python shell or script to get started. + +Editing the documentation +-------------------------- + +Devcontainer version: + +1. Open the Repo in VS Code which should automatically give you the option to open in a devcontainer. +2. Open a terminal in VS Code. +3. Run the following commands in the terminal: :: + + cd /workspaces/gambit/ + pip install . + cd doc + pip install -r requirements.txt + make html + +4. Open ``doc/_build/html/index.html`` in your browser. \ No newline at end of file From c0bda03813bcc4732fbb0f8d6de5692dbaf7785b Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Tue, 5 Aug 2025 16:18:47 +0100 Subject: [PATCH 2/4] Update documentation editing instructions for clarity and completeness --- doc/build.rst | 26 +++++++++++++++++++------- 1 file changed, 19 insertions(+), 7 deletions(-) diff --git a/doc/build.rst b/doc/build.rst index f2c586b96..c7df4d991 100644 --- a/doc/build.rst +++ b/doc/build.rst @@ -145,19 +145,31 @@ using `nose2`. Once installed, simply ``import pygambit`` in your Python shell or script to get started. -Editing the documentation +Editing this documentation -------------------------- -Devcontainer version: +1. If you haven't already, clone the Gambit repository from GitHub: :: -1. Open the Repo in VS Code which should automatically give you the option to open in a devcontainer. -2. Open a terminal in VS Code. -3. Run the following commands in the terminal: :: + 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: :: - cd /workspaces/gambit/ pip install . cd doc pip install -r requirements.txt make html -4. Open ``doc/_build/html/index.html`` in your browser. \ No newline at end of file +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. + +.. TODO: Add instructions for the GitHub workflow during contributor docs refactoring. + See https://github.com/alan-turing-institute/gambit_admin/issues/1 \ No newline at end of file From 1fbc91b17c95395e588dcd3f8a9b0f7ce595285e Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Wed, 6 Aug 2025 10:16:14 +0100 Subject: [PATCH 3/4] Add review process note for documentation contributions --- doc/build.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/build.rst b/doc/build.rst index c7df4d991..07725fa94 100644 --- a/doc/build.rst +++ b/doc/build.rst @@ -171,5 +171,7 @@ Editing this documentation 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/alan-turing-institute/gambit_admin/issues/1 \ No newline at end of file From 5c408d6d6b6cf7a1d43c2d7907b57881c14f2543 Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Wed, 6 Aug 2025 11:21:02 +0100 Subject: [PATCH 4/4] update referenced issue --- doc/build.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/build.rst b/doc/build.rst index 07725fa94..67fa403ec 100644 --- a/doc/build.rst +++ b/doc/build.rst @@ -174,4 +174,4 @@ Editing this documentation 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/alan-turing-institute/gambit_admin/issues/1 \ No newline at end of file + See https://github.com/gambitproject/gambit/issues/541 \ No newline at end of file