From 2454d73c436d5e95518868d0d5c1a02d1d770ab4 Mon Sep 17 00:00:00 2001 From: Max Belanger Date: Mon, 13 May 2024 22:25:00 -0700 Subject: [PATCH 1/3] further fix doc generation, need explicit install of requirements and package itself --- .readthedocs.yml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/.readthedocs.yml b/.readthedocs.yml index 8f1d441..103554e 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -9,5 +9,11 @@ build: tools: python: "3.7" +python: + install: + - requirements: requirements.txt + - method: setuptools + path: . + sphinx: configuration: docs/conf.py From 22d3a1a3d3aa816dc90732db5a6fa960d1b50a34 Mon Sep 17 00:00:00 2001 From: Max Belanger Date: Mon, 13 May 2024 22:49:29 -0700 Subject: [PATCH 2/3] fix theming --- docs/conf.py | 3 ++- requirements.txt | 1 + 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 0766dc4..cf1ce36 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -38,6 +38,7 @@ extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.mathjax', + 'sphinx_rtd_theme', ] # Add any paths that contain templates here, relative to this directory. @@ -108,7 +109,7 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'default' +html_theme = 'sphinx_rtd_theme' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the diff --git a/requirements.txt b/requirements.txt index 2b5b9a8..d95ccf4 100644 --- a/requirements.txt +++ b/requirements.txt @@ -8,5 +8,6 @@ ply pytest pytest-runner==5.2.0 sphinx +sphinx_rtd_theme twine wheel From f14eb17622647e1b2fd1f4cc1a93770c2e274248 Mon Sep 17 00:00:00 2001 From: Max Belanger Date: Mon, 13 May 2024 22:59:19 -0700 Subject: [PATCH 3/3] limit index depth --- docs/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index 1e13d71..912bdc0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,7 +7,7 @@ Dropbox for Python Documentation tutorial .. toctree:: - :maxdepth: 2 + :maxdepth: 1 api/async api/auth