Skip to content

Update to mpl-sphinx-theme 3.7 #34

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

Merged
merged 2 commits into from
Sep 6, 2023
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
13 changes: 10 additions & 3 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@ name: Docs

on: [push, pull_request]

env:
IS_RELEASE: |
${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}

jobs:
build:
Expand All @@ -16,10 +19,14 @@ jobs:
run: pip install -r requirements-doc.txt

- name: Build
run: make html
- name: Publish
run: |
if [ "x$IS_RELEASE" == "xtrue" ]; then
O="-t release"
fi
make html O="$O"

if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
- name: Publish
if: ${{ env.IS_RELEASE == 'true' }}
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
Expand Down
Binary file removed _static/logo2.png
Binary file not shown.
552 changes: 0 additions & 552 deletions _static/logo2.svg

This file was deleted.

1 change: 0 additions & 1 deletion _static/logo2_compressed.svg

This file was deleted.

10 changes: 2 additions & 8 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,13 +62,12 @@
# 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_static_path = ["_static"]

# Fix for table wrapping
# https://rackerlabs.github.io/docs-rackspace/tools/rtd-tables.html

html_css_files = []
html_logo = "_static/logo2.svg"


html_sidebars = {
Expand All @@ -80,12 +79,7 @@


html_theme_options = {
"navbar_links": "server-stable",
"logo": {
"link": "index",
"image_light": "images/logo2.svg",
"image_dark": "images/logo_dark.svg",
},
"navbar_links": ("absolute", "server-stable"),
"collapse_navigation": not is_release_build,
"show_prev_next": False,
# Toc options
Expand Down
2 changes: 1 addition & 1 deletion requirements-doc.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# List required packages in this file, one per line.
mpl-sphinx-theme~=3.6.0
mpl-sphinx-theme~=3.7.1
myst-parser