Browse Source

use the readthedocs theme

pull/1289/head
Ross McFarland 4 months ago
parent
commit
755f618536
No known key found for this signature in database GPG Key ID: 943B179E15D3B22A
3 changed files with 7 additions and 16 deletions
  1. +2
    -7
      docs/conf.py
  2. +2
    -6
      requirements-docs.txt
  3. +3
    -3
      setup.py

+ 2
- 7
docs/conf.py View File

@ -25,6 +25,7 @@ extensions = [
"myst_parser",
"sphinx_copybutton",
"sphinxcontrib.mermaid",
"sphinx_rtd_theme",
]
@ -85,10 +86,4 @@ exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
### theme ###
# html_theme = "alabaster"
html_theme = "furo"
html_theme_options = {
"source_repository": "https://github.com/octodns/octodns/",
"source_branch": "main",
"source_directory": "docs/",
}
html_theme = "sphinx_rtd_theme"

+ 2
- 6
requirements-docs.txt View File

@ -4,26 +4,22 @@ MarkupSafe==3.0.2
Sphinx==7.4.7; python_version=='3.9'
Sphinx==8.1.3; python_version=='3.10'
Sphinx==8.2.3; python_version>='3.11'
accessible-pygments==0.0.5
alabaster==0.7.16; python_version<'3.10'
alabaster==1.0.0; python_version>='3.10'
babel==2.17.0
beautifulsoup4==4.13.4
furo==2025.7.19
imagesize==1.4.1
mdit-py-plugins==0.5.0
myst-parser==3.0.1; python_version<'3.10'
myst-parser==4.0.1; python_version>='3.10'
roman-numerals-py==3.1.0
snowballstemmer==3.0.1
soupsieve==2.7
sphinx-basic-ng==1.0.0b2
sphinx-copybutton==0.5.2
sphinx-rtd-theme==3.0.2
sphinxcontrib-applehelp==2.0.0
sphinxcontrib-devhelp==2.0.0
sphinxcontrib-htmlhelp==2.1.0
sphinxcontrib-jquery==4.1
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-mermaid==1.0.0
sphinxcontrib-qthelp==2.0.0
sphinxcontrib-serializinghtml==2.0.0
typing_extensions==4.14.1

+ 3
- 3
setup.py View File

@ -72,11 +72,11 @@ setup(
'twine>=3.4.2',
),
'docs': (
'Sphinx>=8.2.3',
'furo>=2024.8.6',
'myst-parser>=4.0.1',
'sphinx-copybutton>=0.5.2',
'Sphinx>=8.2.3',
'sphinxcontrib-mermaid>=1.0.0',
'sphinx-copybutton>=0.5.2',
'sphinx_rtd_theme',
),
},
install_requires=(


Loading…
Cancel
Save