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.

Sign up for GitHub

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

[WIP] Switch docs to new mdanalysis-sphinx-theme #146

Closed
wants to merge 2 commits into from
Closed

[WIP] Switch docs to new mdanalysis-sphinx-theme #146

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
193874f
Update for mda sphinx theme, update author names
IAlibay Sep 4, 2023
6f865d1
Add pycache to gitignore
IAlibay Sep 4, 2023
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
4 changes: 2 additions & 2 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ jobs:

- name: Build Sphinx 🔧 # This is built with makefile
run: |
pip install sphinx sphinx-sitemap sphinx_rtd_theme breathe
pip install sphinx sphinx-sitemap mdanalysis_sphinx_theme breathe
cd docs
make html

Expand All @@ -58,4 +58,4 @@ jobs:
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
BRANCH: gh-pages # The branch the action should deploy to.
FOLDER: docs/_build/html # The folder the action should deploy.
FOLDER: docs/_build/html # The folder the action should deploy.
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ distopia.egg-info/
.idea/
.vscode/
.DS_store
__pycache__
28 changes: 5 additions & 23 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,9 @@
# sys.path.insert(0, os.path.abspath('../')

# -- Project information -----------------------------------------------------
import sphinx_rtd_theme

project = 'distopia'
copyright = '2022, Hugo MacDermott-Opeskin Jakub Nabaglo Richard Gowers'
author = 'Hugo MacDermott-Opeskin Jakub Nabaglo Richard Gowers'
copyright = '2022, Hugo MacDermott-Opeskin Jacqueline Nabaglo Richard Gowers'
author = 'Hugo MacDermott-Opeskin Jacqueline Nabaglo Richard Gowers'


# -- General configuration ---------------------------------------------------
Expand Down Expand Up @@ -57,25 +55,10 @@
# 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_path = [
sphinx_rtd_theme.get_html_theme_path()
]
html_theme = 'mdanalysis_sphinx_theme'

html_theme_options = {
'canonical_url': '',
'logo_only': True,
'display_version': True,
'prev_next_buttons_location': 'bottom',
'style_external_links': False,
'style_nav_header_background': 'white',
# Toc options
'collapse_navigation': True,
'sticky_navigation': True,
'navigation_depth': 4,
'includehidden': True,
'titles_only': False,
'mda_official': True,
}

# options common to RTD and MDAnalysis theme
Expand All @@ -85,5 +68,4 @@
# so a file named "default.css" will overwrite the builtin "default.css".
# For RTD theme: custom.css to override theme defaults.
html_static_path = ['_static']
html_css_files = ['custom.css']
html_logo = "_static/logos/mdanalysis-logo-thin.png"
# html_css_files = []