Browse Source

Merge pull request #101 from Learnware-LAMDA/refactor_doc

Refactor doc
tags/v0.3.2
bxdd GitHub 2 years ago
parent
commit
8091ba79fb
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 5 additions and 22 deletions
  1. +1
    -1
      docs/_static/css/custom_style.css
  2. +3
    -20
      docs/conf.py
  3. +1
    -1
      setup.py

+ 1
- 1
docs/_static/css/custom_style.css View File

@@ -1,3 +1,3 @@
.wy-nav-content {
max-width: 1200px !important;
max-width: none;
}

+ 3
- 20
docs/conf.py View File

@@ -1,5 +1,5 @@
import pkg_resources
import sphinx_rtd_theme
import sphinx_book_theme

# Configuration file for the Sphinx documentation builder.
#
@@ -90,12 +90,10 @@ todo_include_todos = True
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
html_theme = "sphinx_book_theme"
html_theme_path = [sphinx_book_theme.get_html_theme_path()]
html_theme_options = {
"logo_only": True,
"collapse_navigation": False,
"display_version": False,
"navigation_depth": 4,
}

@@ -111,21 +109,6 @@ html_css_files = [
'css/custom_style.css',
]

# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# This is required for the alabaster theme
# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
html_sidebars = {
"**": [
"about.html",
"navigation.html",
"relations.html", # needs 'show_related': True theme option to display
"searchbox.html",
]
}


# -- Options for HTMLHelp output ------------------------------------------

# Output file base name for HTML help builder.


+ 1
- 1
setup.py View File

@@ -57,7 +57,7 @@ REQUIRED = [
DEV_REQUIRED = [
# For documentations
"sphinx",
"sphinx_rtd_theme",
"sphinx_book_theme",
# CI dependencies
"pytest>=3",
"wheel",


Loading…
Cancel
Save