Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: convert recommonmark to myst-parser #14

Merged
merged 1 commit into from
Apr 15, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions {{cookiecutter.project_name}}/docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,15 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
"myst_parser",
"sphinx.ext.autodoc",
"sphinx.ext.mathjax",
"sphinx.ext.napoleon",
"sphinx_copybutton",
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
templates_path = []

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
Expand All @@ -41,7 +43,19 @@
# 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 = "sphinx_book_theme"

html_title = f"Hist {version}"

html_baseurl = "https://{{ cookiecutter.project_name.replace("-", "_") }}.readthedocs.io/en/latest/"

html_theme_options = {
"home_page_in_toc": True,
"repository_url": "{{ cookiecutter.url }}",
"use_repository_button": True,
"use_issues_button": True,
"use_edit_page_button": True,
}

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
Expand Down
4 changes: 2 additions & 2 deletions {{cookiecutter.project_name}}/pyproject-flit.toml
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,10 @@ dev = [
"pytest >=4.6",
]
docs = [
"recommonmark >=0.5.0",
"Sphinx >=3.0.0",
"myst_parser>=0.13",
"sphinx-book-theme>=0.0.33",
"sphinx_copybutton",
"sphinx_rtd_theme >=0.5.0",
]

[build-system]
Expand Down
4 changes: 2 additions & 2 deletions {{cookiecutter.project_name}}/pyproject-poetry.toml
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,10 @@ dev = [
"pytest >=4.6",
]
docs = [
"recommonmark >=0.5.0",
"Sphinx >=3.0.0",
"myst_parser>=0.13",
"sphinx-book-theme>=0.0.33",
"sphinx_copybutton",
"sphinx_rtd_theme >=0.5.0",
]

[build-system]
Expand Down
4 changes: 2 additions & 2 deletions {{cookiecutter.project_name}}/setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,9 @@ dev =
pytest>=4.6
docs =
Sphinx>=3.0.0
recommonmark>=0.5.0
myst_parser>=0.13
sphinx-book-theme>=0.0.33
sphinx_copybutton
sphinx_rtd_theme>=0.5.0
test =
pytest>=4.6

Expand Down