docs: update conf.py
MODIFY
docs/source/conf.py
docs/source/conf.py
-# -- General configuration ------------------------------------------------
+# Configuration file for Sphinx to build our documentation to HTML.
+#
+# Configuration reference: https://www.sphinx-doc.org/en/master/usage/configuration.html
+#
+import datetime
+
+
+# -- Project information -----------------------------------------------------
+# ref: https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+#
+project = "BinderHub"
+copyright = f"{datetime.date.today().year}, Project Jupyter Contributors"
+author = "Project Jupyter Contributors"
+
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
+# -- General Sphinx configuration ---------------------------------------------------
+# ref: https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+#
extensions = [
"myst_parser",
"sphinx.ext.extlinks",
"sphinxcontrib.autoprogram",
]
-
+root_doc = "index"
+source_suffix = [".md", ".rst"]
+default_role = "literal"
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+templates_path = ["_templates"]
extlinks = {
"issue": ("https://github.com/jupyterhub/repo2docker/issues/%s", "Issue #"),
"pr": ("https://github.com/jupyterhub/repo2docker/pull/%s", "PR #"),
"user": ("https://github.com/%s", "@"),
}
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ["_templates"]
-
-
-def setup(app):
- app.add_css_file("custom.css") # may also be a URL
-
-# The suffix(es) of source filenames.
-# You can specify multiple suffix as a list of string:
+# -- General MyST configuration -----------------------------------------------------
+# ref: https://myst-parser.readthedocs.io/en/latest/configuration.html
#
-# source_suffix = ['.rst', '.md']
-source_suffix = [".rst", ".md"]
-
-# The root toctree document.
-root_doc = master_doc = "index"
+myst_enable_extensions = [
+ "colon_fence",
+]
-# General information about the project.
-project = "repo2docker"
-copyright = "2019, Project Jupyter"
-author = "Project Jupyter"
+# -- Referenceable variables --------------------------------------------------
+#
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
@@ -59,130 +65,25 @@ rst_prolog = """
default_python=default_python
)
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#
-# This is also used if you do content translation via gettext catalogs.
-# Usually you set "language" from the command line for these cases.
-language = None
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = []
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = "sphinx"
-
-# If true, `todo` and `todoList` produce output, else they produce nothing.
-todo_include_todos = False
-
-# MyST configuration
-
-myst_enable_extensions = [
- "colon_fence",
-]
-
-
-# -- Options for HTML output ----------------------------------------------
-
-# The theme to use for HTML and HTML Help pages. See the documentation for
-# a list of builtin themes.
+# -- Options for HTML output -------------------------------------------------
+# ref: https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
#
-html_theme = "pydata_sphinx_theme"
html_logo = "_static/images/logo.png"
html_favicon = "_static/images/favicon.ico"
-
-# 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 = {}
-
-# 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,
-# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]
-html_sidebars = {}
-
-# -- Options for HTMLHelp output ------------------------------------------
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = "repo2dockerdoc"
+html_css_files = ["custom.css"]
-
-# -- Options for LaTeX output ---------------------------------------------
-
-latex_elements = {
- # The paper size ('letterpaper' or 'a4paper').
- #
- # 'papersize': 'letterpaper',
- # The font size ('10pt', '11pt' or '12pt').
- #
- # 'pointsize': '10pt',
- # Additional stuff for the LaTeX preamble.
- #
- # 'preamble': '',
- # Latex figure (float) alignment
- #
- # 'figure_align': 'htbp',
+# pydata_sphinx_theme reference: https://pydata-sphinx-theme.readthedocs.io/en/latest/
+html_theme = "pydata_sphinx_theme"
+html_theme_options = {
+ "use_edit_page_button": True,
+ "github_url": "https://github.com/jupyterhub/repo2docker",
+ "twitter_url": "https://twitter.com/mybinderteam",
+}
+html_context = {
+ "github_user": "jupyterhub",
+ "github_repo": "repo2docker",
+ "github_version": "main",
+ "doc_path": "docs/source",
}
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title,
-# author, documentclass [howto, manual, or own class]).
-latex_documents = [
- (
- master_doc,
- "repo2docker.tex",
- "repo2docker Documentation",
- "Project Jupyter",
- "manual",
- )
-]
-
-
-# -- Options for manual page output ---------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-man_pages = [(master_doc, "repo2docker", "repo2docker Documentation", [author], 1)]
-
-
-# -- Options for Texinfo output -------------------------------------------
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-# dir menu entry, description, category)
-texinfo_documents = [
- (
- master_doc,
- "repo2docker",
- "repo2docker Documentation",
- author,
- "repo2docker",
- "One line description of project.",
- "Miscellaneous",
- )
-]
-
-
-# -- Options for Epub output ----------------------------------------------
-
-# Bibliographic Dublin Core info.
-epub_title = project
-epub_author = author
-epub_publisher = author
-epub_copyright = copyright
-
-# The unique identifier of the text. This can be a ISBN number
-# or the project homepage.
-#
-# epub_identifier = ''
-
-# A unique identification for the text.
-#
-# epub_uid = ''
-
-# A list of files that should not be packed into the epub file.
-epub_exclude_files = ["search.html"]

docs: update conf.py