From 3240a327ccde0348e1e2fa843ae62326c03db043 Mon Sep 17 00:00:00 2001 From: John McNamara Date: Thu, 19 Oct 2023 11:58:16 +0100 Subject: [PATCH] docs: fix readthedos build issue Issue #1021 --- .readthedocs.yaml | 6 +++--- dev/docs/requirements.txt | 3 +++ dev/docs/source/conf.py | 14 +++++++------- 3 files changed, 13 insertions(+), 10 deletions(-) create mode 100644 dev/docs/requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 7e80517fb..7c6b7135a 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -17,7 +17,7 @@ sphinx: # We recommend specifying your dependencies to enable reproducible builds: # https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html -# python: -# install: -# - requirements: docs/requirements.txt +python: + install: + - requirements: dev/docs/requirements.txt diff --git a/dev/docs/requirements.txt b/dev/docs/requirements.txt new file mode 100644 index 000000000..31cb0e4c4 --- /dev/null +++ b/dev/docs/requirements.txt @@ -0,0 +1,3 @@ +sphinx-bootstrap-theme +sphinx_rtd_theme + diff --git a/dev/docs/source/conf.py b/dev/docs/source/conf.py index a57a123ba..f09eea465 100644 --- a/dev/docs/source/conf.py +++ b/dev/docs/source/conf.py @@ -15,10 +15,10 @@ pygments_style = 'sphinx' intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} -sys.path.append(os.path.abspath('_themes')) -html_theme_path = ['_themes'] -html_theme = 'bootstrap' -html_theme_options = {'nosidebar': True} +#sys.path.append(os.path.abspath('_themes')) +#html_theme_path = ['_themes'] +html_theme = 'sphinx_rtd_theme' +#html_theme_options = {'nosidebar': True} html_title = "XlsxWriter Documentation" html_static_path = ['_static'] html_show_sphinx = True @@ -60,6 +60,6 @@ linkcheck_ignore = ["https://www.paypal.com"] -extlinks = {'issue': ('https://github.com/jmcnamara/XlsxWriter/issues/%s', 'Issue #'), - 'feature': ('https://github.com/jmcnamara/XlsxWriter/issues/%s', 'Feature Request #'), - 'pull': ('https://github.com/jmcnamara/XlsxWriter/pull/%s', 'Pull Request #')} +extlinks = {'issue': ('https://github.com/jmcnamara/XlsxWriter/issues/%s', 'Issue %s'), + 'feature': ('https://github.com/jmcnamara/XlsxWriter/issues/%s', 'Feature Request %s'), + 'pull': ('https://github.com/jmcnamara/XlsxWriter/pull/%s', 'Pull Request %s')}