Cleanup docs & use guzzle team

This commit is contained in:
Stijn Van Campenhout
2019-09-19 09:22:45 +02:00
parent d70f777da4
commit a748bf9dd5
3 changed files with 16 additions and 1 deletions

View File

@@ -1,3 +1,4 @@
import guzzle_sphinx_theme
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
@@ -70,3 +71,16 @@ napoleon_use_admonition_for_references = False
napoleon_use_ivar = False
napoleon_use_param = True
napoleon_use_rtype = True
html_theme_path = guzzle_sphinx_theme.html_theme_path()
html_theme = 'guzzle_sphinx_theme'
# Register the theme as an extension to generate a sitemap.xml
extensions.append("guzzle_sphinx_theme")
# Guzzle theme options (see theme.conf for more information)
html_theme_options = {
# Set the name of the project to appear in the sidebar
"project_nav_name": "Project Name",
}

View File

@@ -18,7 +18,7 @@ API Support
| ☑️ download a specific file
| ☑️ create a directory
| ☑️ move / rename a file or directory
| ☑️ upload a file
| upload a file
| ❎ delete a file or directory
| ❎ shell
| ❎ annotiation exports

View File

@@ -2,4 +2,5 @@ requests
pyaml==19.4.1
sphinx==2.2.0
sphinx-autodoc-typehints==1.8.0
guzzle-sphinx-theme==0.7.11