Skip to content

Commit

Permalink
Simplify documentation requirements
Browse files Browse the repository at this point in the history
  • Loading branch information
gunthercox committed Feb 8, 2025
1 parent 0a54842 commit 83e57d9
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 9 deletions.
3 changes: 1 addition & 2 deletions dev-requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@ pymongo>=3.3,<4.0
twine
twython
spacy>=2.3,<3.0
sphinx>=5.3,<8.1
sphinx_rtd_theme
sphinx>=5.3,<8.2
pyyaml>=5.3,<5.4
git+https://github.com/gunthercox/chatterbot-corpus.git@master
https://github.com/explosion/spacy-models/releases/download/en_core_web_sm-2.3.0/en_core_web_sm-2.3.0.tar.gz#egg=en_core_web_sm
Expand Down
31 changes: 24 additions & 7 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import os
import sys
import configparser
from pathlib import Path
from datetime import datetime
import sphinx_rtd_theme


config = configparser.ConfigParser()
Expand All @@ -17,6 +17,7 @@
# This lets us ensure that the source package is imported, and used to generate the documentation.
sys.path.insert(0, parent_directory)

sys.path.append(str(Path('_ext').resolve()))

# Sphinx extension modules
extensions = [
Expand All @@ -27,7 +28,8 @@
'sphinx.ext.intersphinx',
'sphinx.ext.mathjax',
'sphinx.ext.todo',
'sphinx.ext.viewcode'
'sphinx.ext.viewcode',
'github',
]

# Add any paths that contain templates here, relative to this directory.
Expand Down Expand Up @@ -80,16 +82,25 @@

# -- Options for HTML output ----------------------------------------------

html_theme = 'sphinx_rtd_theme'
html_theme = 'classic'

# 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
# documentation.
html_theme_options = {
'logo_only': True
'externalrefs': True,
'sidebarbgcolor': '#300a24',
'relbarbgcolor': '#26001b',
'footerbgcolor': '#13000d',
'headbgcolor': '#503949',
'headtextcolor': '#e8ffca',
'headlinkcolor': '#e8ffca',
'sidebarwidth': '300px',
}

html_show_sourcelink = False
root_doc = 'index'

html_show_sourcelink = True

# A shorter title for the navigation bar. Default is the same as html_title.
# html_short_title = None
Expand All @@ -116,10 +127,16 @@
# If not None, a 'Last updated on:' timestamp is inserted at every page
# bottom, using the given strftime format.
# The empty string is equivalent to '%b %d, %Y'.
# html_last_updated_fmt = None
html_last_updated_fmt = None

# Custom sidebar templates, maps document names to template names.
# html_sidebars = {}
html_sidebars = {
'**': ['searchbox.html', 'globaltoc.html', 'sidebar_ad.html']
}

html_css_files = [
'style.css'
]

# Additional templates that should be rendered to pages, maps page names to
# template names.
Expand Down

0 comments on commit 83e57d9

Please sign in to comment.