Gh-25: Improve docs landing page (#26)

* Improve docs landing page * Add docs building instructions * Update README.md Co-authored-by: GCHQDeveloper314 <94527357+GCHQDeveloper314@users.noreply.github.com> * PR comments --------- Co-authored-by: GCHQDeveloper314 <94527357+GCHQDeveloper314@users.noreply.github.com>
gchq · Oct 17, 2023 · d7cc3b3 · d7cc3b3
1 parent de977a3
commit d7cc3b3
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 # Gaffer Python Client
 
 ![ci](https://github.com/gchq/gafferpy/actions/workflows/continuous-integration.yaml/badge.svg)
-[<img src="https://img.shields.io/badge/docs-passing-success.svg?logo=readthedocs">](https://gchq.github.io/gaffer-doc/latest/)
+[<img src="https://img.shields.io/badge/docs-passing-success.svg?logo=readthedocs">](https://gchq.github.io/gafferpy/)
 
 ## Features
 
@@ -89,6 +89,19 @@ mvn verify -Proad-traffic-demo
 python -m unittest discover
 ```
 
+## Building the documentation
+
+To build the docs locally, assuming you have Python installed, install the docs dependencies:
+```bash
+cd docs
+pip install -r requirements.txt
+```
+
+Then use the sphinx Makefile:
+```bash
+make html
+```
+
 ## License
 
 Copyright 2016-2022 Crown Copyright

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1 +1,2 @@
-sphinx-rtd-theme==1.3.0
+sphinx~=7.2.6
+sphinx-rtd-theme~=1.3.0
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -36,6 +36,8 @@
     'sphinx.ext.napoleon'
 ]
 
+pygments_style = 'sphinx'
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -6,6 +6,10 @@
 Welcome to gafferpy's documentation!
 ====================================
 
+`gafferpy <https://github.com/gchq/gafferpy>`_ is the Python shell for `Gaffer <https://github.com/gchq/Gaffer>`_. It enables creation and execution of operation chains in Python.
+This site is generated by `sphinx <https://www.sphinx-doc.org/en/master/>`_ from the gafferpy docstrings. To build the docs locally, see the `gafferpy README <https://github.com/gchq/gafferpy#building-the-documentation>`_.
+For Gaffer documentation, instead go to the `Gaffer docs <https://gchq.github.io/gaffer-doc/latest/>`_.
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents: