mirror of
https://github.com/jupyter/docker-stacks.git
synced 2025-10-14 21:42:57 +00:00
Try sphinx-book-theme@master
This commit is contained in:
2
.github/workflows/sphinx.yml
vendored
2
.github/workflows/sphinx.yml
vendored
@@ -34,7 +34,7 @@ jobs:
|
|||||||
- name: Set Up Python
|
- name: Set Up Python
|
||||||
uses: actions/setup-python@v2
|
uses: actions/setup-python@v2
|
||||||
with:
|
with:
|
||||||
python-version: 3.x
|
python-version: "3.9"
|
||||||
|
|
||||||
- name: Install Dev Dependencies
|
- name: Install Dev Dependencies
|
||||||
run: |
|
run: |
|
||||||
|
23
docs/conf.py
23
docs/conf.py
@@ -67,20 +67,21 @@ html_static_path = ["_static"]
|
|||||||
# sphinx-quickstart --project "docker-stacks" --author "Project Jupyter" -v "latest" -r "latest" -l en --no-sep --no-makefile --no-batchfile
|
# sphinx-quickstart --project "docker-stacks" --author "Project Jupyter" -v "latest" -r "latest" -l en --no-sep --no-makefile --no-batchfile
|
||||||
# These are custom options for this project
|
# These are custom options for this project
|
||||||
|
|
||||||
|
html_theme = "sphinx_book_theme"
|
||||||
|
html_title = "Docker Stacks documentation"
|
||||||
|
html_logo = "_static/jupyter-logo.svg"
|
||||||
|
html_theme_options = {
|
||||||
|
"path_to_docs": "docs",
|
||||||
|
"repository_url": "https://github.com/jupyter/docker-stacks",
|
||||||
|
"use_edit_page_button": True,
|
||||||
|
"use_issues_button": True,
|
||||||
|
"use_repository_button": True,
|
||||||
|
"use_download_button": True,
|
||||||
|
}
|
||||||
|
|
||||||
extensions = ["myst_parser", "sphinx_copybutton"]
|
extensions = ["myst_parser", "sphinx_copybutton"]
|
||||||
source_suffix = {
|
source_suffix = {
|
||||||
".rst": "restructuredtext",
|
".rst": "restructuredtext",
|
||||||
".md": "markdown",
|
".md": "markdown",
|
||||||
}
|
}
|
||||||
pygments_style = "sphinx"
|
pygments_style = "sphinx"
|
||||||
|
|
||||||
html_theme_options = {
|
|
||||||
"description": "Jupyter Docker Stacks",
|
|
||||||
"fixed_sidebar": False,
|
|
||||||
"show_relbars": True,
|
|
||||||
"github_user": "jupyter",
|
|
||||||
"github_repo": "docker-stacks",
|
|
||||||
"github_type": "star",
|
|
||||||
"logo": "jupyter-logo.svg",
|
|
||||||
"logo_text_align": "left",
|
|
||||||
}
|
|
||||||
|
@@ -1,3 +1,8 @@
|
|||||||
myst-parser
|
# ReadTheDocs environment contains old package versions preinstalled
|
||||||
sphinx
|
# So, to ensure we have modern packages, we pin minimum versions of the packages we need
|
||||||
sphinx-copybutton
|
docutils>=0.17
|
||||||
|
myst-parser>=0.16.1
|
||||||
|
sphinx>=4.4.0
|
||||||
|
# sphinx-book-theme>=0.2.0
|
||||||
|
git+https://github.com/executablebooks/sphinx-book-theme@master#egg=sphinx-book-theme
|
||||||
|
sphinx-copybutton>=0.4.0
|
||||||
|
Reference in New Issue
Block a user