diff --git a/docs/conf.py b/docs/conf.py index 68a5c97..8ced84e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -81,6 +81,7 @@ exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] # -- Options for HTML output ------------------------------------------------- +# If HTML theme settings isn't lines 86-110, remember to change customization.rst # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. @@ -91,8 +92,6 @@ # so a file named 'default.css' will overwrite the builtin 'default.css'. html_static_path = ["_static"] -# If HTML theme settings isn't lines 90-160, remember to change customization.rst - # -- HTML theme settings ------------------------------------------------ html_show_sourcelink = True html_sidebars = { @@ -109,7 +108,7 @@ "mda_official": True, } -# If HTML theme settings isn't lines 90-160, remember to change customization.rst +# If HTML theme settings isn't lines 86-110, remember to change customization.rst language = "en" html_last_updated_fmt = "" diff --git a/docs/customization.rst b/docs/customization.rst index 492c170..e6f6786 100644 --- a/docs/customization.rst +++ b/docs/customization.rst @@ -10,8 +10,8 @@ This site's options are: .. literalinclude:: conf.py :language: python - :lines: 90-160 - :lineno-start: 90 + :lines: 86-110 + :lineno-start: 86 :linenos: Many of these settings are provided in this site as examples; for a minimalistic example, see :ref:`quickstart`. @@ -19,52 +19,21 @@ Many of these settings are provided in this site as examples; for a minimalistic Configuration Options ===================== -``google_analytics_account`` - Set to enable google analytics. +Listed below are important customisation options for the `mdanalysis-sphinx-theme`. +Please see the `sphinx-rtd-theme configuration`_ documentation for more +information on other options. + ``repo_url`` Set the repo url for the link to appear. ``repo_name`` The name of the repo. It must be set if repo_url is set. -``repo_type`` - Must be one of github, gitlab or bitbucket. -``globaltoc_depth`` - The maximum depth of the global TOC; set it to -1 to allow unlimited depth. -``globaltoc_collapse`` - If true, TOC entries that are not ancestors of the current page are collapsed. -``globaltoc_includehidden`` - If true, the global TOC tree will also contain hidden entries. -``globaltoc_include_local`` - If true, the global TOC tree will include the current page's localtoc entries if the localtoc is not rendered on the page +``mda_official`` + Whether to use official MDA branding, e.g. its logo ``color_accent`` - Accent color. Options are ``openff-blue``, ``openff-toolkit-blue``, - ``openff-yellow``, ``openff-orange``, ``aquamarine``, ``lilac``, - ``amaranth``, ``grape``, ``violet``, ``pink``, ``pale-green``, ``green``, - ``crimson``, ``eggplant``, ``turquoise``, or any valid CSS color. -``html_hyphenate_and_justify`` - If true, hyphenate and justify prose content. Doesn't affect API docs. - Quality of hyphenation will vary from browser to browser. -``html_minify`` - Minify pages after creation using htmlmin. -``html_prettify`` - Prettify pages. Just for debugging, this will change how the page is rendered. + Accent color. Choose any valid CSS color, or `mdanalysis-orange`. ``css_minify`` Minify css files found in the output directory. -``master_doc`` - Include the master document at the top of the page in the breadcrumb bar. -``nav_links`` - A list of dictionaries where each has three keys: - - - ``href``: The URL or pagename (str) - - ``title``: The title to appear (str) - - ``internal``: Flag indicating to use pathto to find the page. Set to False for external content. (bool) -``heroes`` - A ``dict[str,str]`` where the key is a pagename and the value is the text to display in the page's hero location. -``socials`` - ``list[dict[str, str]]`` of social media links. - Dicts have three keys: ``"href"``, ``"icon_classes"``, and optionally ``"title"``. - Icon classes should be from `Academicons `_ or `Font Awesome 5 `_. - If not specified, defaults to a set of links appropriate for an OpenFF Initiative project. Sidebars ======== @@ -121,13 +90,5 @@ Finally, edit your override file ``source/_templates/layout.html``: {{ super() }} {%- endblock %} -New Blocks -========== -The theme has a small number of new blocks to simplify some types of -customization: - -``footerrel`` - Previous and next in the footer. -``fonticon`` - Block that contains the icon font. You should probably call ``{{ super() }}`` at the end of the block to include the default icon fonts as well. (Font Awesome and Academicons) +.. _`sphinx-rtd-theme configuration`: https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html \ No newline at end of file