Merge pull request #183 from Seshat-Global-History-Databank/add-docs-…

…preview-to-docs Update documentation build instructions to include docs preview
Seshat-Global-History-Databank · Nov 25, 2024 · c3088b6 · c3088b6
2 parents b7c707f + c1c8259
commit c3088b6
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/docs/source/how-to-update-these-docs.rst b/docs/source/how-to-update-these-docs.rst
@@ -69,7 +69,7 @@ Once you have these pre-requisites, you can follow the steps below to update the
 
     - If adding new pages, ensure they are added to the "toctree" at the top of the `index.rst` file present in the same directory.
 
-5. [Optional] Build the documentation locally to check that your changes are rendering correctly.
+5. [Optional] Build the documentation locally to check that your changes are rendering correctly. Note: when opening a pull request in the last step you will be able to see a preview of the changes on GitHub anyway, but this could be quicker if you have a lot of changes to check.
 
     - Install the required dependencies for building the documentation. You may wish to use a virtual environment to avoid conflicts with other Python packages.
 
@@ -118,6 +118,11 @@ Once you have these pre-requisites, you can follow the steps below to update the
 
     - Click "Create pull request" and add a descriptive title and description to the pull request.
 
+    - The documentation will be built automatically and you will be able to see a preview of the changes on the pull request page. Click "Details".
+
+    .. image:: img/PR_docs_preview.png
+        :alt: Docs preview
+
     - A Seshat Databank Admin will review your changes and may request further changes before merging the pull request.
 
     - Once your pull request is merged, the changes will take a few moments before being reflected on this website.
diff --git a/docs/source/img/PR_docs_preview.png b/docs/source/img/PR_docs_preview.png