Documentation Updates

- updated conf.py with some new settings
- updated the documentation
- provided an example of section heading
- added a few additional requirements

docs/conf.py

@@ -28,8 +28,20 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.venv']
 html_theme = "sphinx_rtd_theme"
 html_static_path = ['static']
 html_logo = "spiffworkflow_logo.png"
+
 html_theme_options = {
     'logo_only': True,
     'display_version': False,
+    'prev_next_buttons_location': 'bottom',
+    'style_external_links': False,
+    'vcs_pageview_mode': '',
+    # Toc options
+    'collapse_navigation': False,
+    'sticky_navigation': True,
+    'navigation_depth': 4,
+    'includehidden': True,
+    'titles_only': False
 }
+
+
 html_css_files = ["custom.css"]

docs/documentation/documentation.md

@@ -131,7 +131,7 @@ You can do that by following these steps:
 ### Step 6: Fire up the website
 
 1. Go to Terminal ->  New Terminal
-1. type:  **sphinx-autobuild . _build/html** at the prompt and hit enter.
+1. type:  **sphinx-autobuild . _build/html  -W -a -j auto -n** at the prompt and hit enter.
 1. Open your browser and go to [http://127.0.0.1:8000](http://127.0.0.1:8000).
 
 

docs/index.md

@@ -2,15 +2,25 @@
 
 ```{toctree}
 :maxdepth: 2
-:caption: Contents
+:caption: Getting Started
 quick_start/quick_start.md
-documentation/documentation.md
-how_to/bpmn_unit_tests.md
-admin_guide/admin_guide.md
-wish_list/wish_list.md
-
 ```
 
+```{toctree}
+:maxdepth: 2
+:caption: Administration
+admin_guide/admin_guide.md
+how_to/bpmn_unit_tests.md
+```
+
+```{toctree}
+:maxdepth: 2
+:caption: Contributing
+documentation/documentation.md
+wish_list/wish_list.md
+```
+
+
 ## Indices and tables
 
 * [](genindex)

docs/requirements.txt

@@ -3,12 +3,15 @@ appdirs==1.4.4
 astroid==2.15.5
 attrs==23.1.0
 Babel==2.12.1
+beautifulsoup4==4.12.2
 cattrs==22.2.0
 certifi==2023.5.7
 charset-normalizer==3.1.0
+click==8.1.3
 colorama==0.4.6
 docutils==0.18.1
 esbonio==0.16.1
+furo==2022.9.29
 idna==3.4
 imagesize==1.4.1
 Jinja2==3.1.2
@@ -28,9 +31,12 @@ PyYAML==6.0
 requests==2.30.0
 six==1.16.0
 snowballstemmer==2.2.0
-Sphinx==6.2.1
+soupsieve==2.4.1
+Sphinx==5.3.0
 sphinx-autoapi==2.1.0
 sphinx-autobuild==2021.3.14
+sphinx-basic-ng==1.0.0b1
+sphinx-click==4.3.0
 sphinx-rtd-theme==1.2.0
 sphinxcontrib-applehelp==1.0.4
 sphinxcontrib-devhelp==1.0.2