Skip to content

Commit

Permalink
DOC: some more formatting fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
ColmTalbot committed Jun 14, 2024
1 parent 4613af4 commit f207f2a
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 25 deletions.
26 changes: 14 additions & 12 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
if not version_match or version_match.isdigit() or version_match == "latest":
# For local development, infer the version to match from the package.
if "dev" in release or "rc" in release:
version_match = "dev"
version_match = "latest"
# We want to keep the relative reference if we are in dev mode
# but we want the whole url if we are effectively in a released version
json_url = "_static/switcher.json"
Expand All @@ -65,23 +65,25 @@


html_theme_options = {
"navbar_center": ["version-switcher", "navbar-nav"],
# "navbar_start": ["navbar-logo"],
# "navbar_end": ["theme-switcher", "navbar-icon-links"],
# "navbar_persistent": ["search-button"],
# "primary_sidebar_end": ["custom-template", "sidebar-ethical-ads"],
# "article_footer_items": ["test", "test"],
# "content_footer_items": ["test", "test"],
"logo": {"text": "wcosmo"},
"navbar_center": ["navbar-nav"],
"navbar_start": ["navbar-logo", "version-switcher"],
"navbar_end": ["theme-switcher", "navbar-icon-links"],
"use_edit_page_button": True,
"show_version_warning_banner": True,
"footer_start": ["copyright"],
"footer_center": ["sphinx-version"],
# "secondary_sidebar_items": {
# "**/*": ["page-toc", "edit-this-page", "sourcelink"],
# "examples/no-sidebar": [],
# },
"switcher": {
"json_url": json_url,
"version_match": version_match,
},
"icon_links": [
{
"name": "GitHub",
"url": "https://github.com/ColmTalbot/wcosmo",
"icon": "fa-brands fa-github",
},
],
}

html_context = {
Expand Down
15 changes: 2 additions & 13 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,19 +1,8 @@
.. currentmodule:: wcosmo

.. include:: ../../README.rst

Examples
--------

.. toctree::
:maxdepth: 2
:hidden:

Examples <examples/index>

API Reference
-------------

.. toctree::
:maxdepth: 2

API <api/index>
Changelog <https://github.com/ColmTalbot/wcosmo/releases>

0 comments on commit f207f2a

Please sign in to comment.