From f5f12a77e1fce7a94c42e9da6a9dbbe8d5075324 Mon Sep 17 00:00:00 2001 From: Lily Wang Date: Wed, 8 Jul 2020 11:38:37 -0700 Subject: [PATCH 1/3] switch doc to User Guide style (based on RTD) - fix #43 - use RTD theme & update conf.py - update custom.css - update travis (install RTD theme and also build 3.6-3.8 and take the docs from the 3.8 build) - update CHANGELOG - add @lilyminium to AUTHORS and authors in conf.py --- .travis.yml | 12 +- AUTHORS | 3 + CHANGELOG.md | 5 + docs/_static/custom.css | 146 +++++++++++- docs/_static/readable.css | 463 -------------------------------------- docs/conf.py | 219 +++++++++++------- 6 files changed, 289 insertions(+), 559 deletions(-) delete mode 100644 docs/_static/readable.css diff --git a/.travis.yml b/.travis.yml index 1ac6123..76a0e72 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,8 +1,10 @@ +version: ~> 1.0 language: python cache: pip -sudo: false python: + - "3.8" + - "3.7" - "3.6" - "2.7" @@ -11,7 +13,7 @@ branches: - master install: - - if [[ $TRAVIS_PYTHON_VERSION == "3.6" ]]; then pip install --upgrade sphinx sphinx-sitemap; fi + - if [[ $TRAVIS_PYTHON_VERSION == "3.8" ]]; then pip install --upgrade sphinx sphinx-sitemap sphinx-rtd-theme; fi - pip install --upgrade pytest pytest-pep8 pytest-cov pytest-mock codecov - pip install -e . @@ -19,9 +21,9 @@ script: - pytest -v --cov MDAnalysisData MDAnalysisData after_success: - # only need to build docs on 3.6 version + # only need to build docs on latest version # touch .nojekyll else github-pages messes up theme - - if [[ $TRAVIS_PYTHON_VERSION == "3.6" ]]; then python setup.py build_sphinx && touch ./build/sphinx/html/.nojekyll; fi + - if [[ $TRAVIS_PYTHON_VERSION == "3.8" ]]; then python setup.py build_sphinx && touch ./build/sphinx/html/.nojekyll; fi - codecov deploy: @@ -32,6 +34,6 @@ deploy: github_token: $GITHUB_TOKEN on: branch: master - python: "3.6" + python: "3.8" local_dir: build/sphinx/html project_name: MDAnalysisData diff --git a/AUTHORS b/AUTHORS index a2b2471..1b23099 100644 --- a/AUTHORS +++ b/AUTHORS @@ -10,3 +10,6 @@ addresses are all optional. - Shujie Fan @VOD555 - Micaela Matta @micaela-matta - Richard J. Gowers @richardjgowers + +2020 + - Lily Wang @lilyminium diff --git a/CHANGELOG.md b/CHANGELOG.md index f965910..0d701f5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [0.8.1] - YYYY-MM-DD + +### Changes +- update online docs theme (#43) + ## [0.8.0] - 2019-08-13 ### Added diff --git a/docs/_static/custom.css b/docs/_static/custom.css index cd04a42..c069992 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -1,12 +1,14 @@ -/* override css for readable.css */ +/* custom MDAnalysis styling (User Guide theme) */ -/* styles/fonts to match http://mdanalysis.org (see public/css) */ +/* See https://github.com/MDAnalysis/mdanalysis/wiki/MDAnalysis-theme-colours */ /* MDAnalysis orange: #FF9200 */ /* MDAnalysis gray: #808080 */ /* MDAnalysis white: #FFFFFF */ /* MDAnalysis black: #000000 */ - -@import url('readable.css'); +/* Darker orange: e76900 */ +/* Even darker orange: #a24900 */ +/* RTD dark grey: #343131 */ +/* RTD light grey: #e6e6e6 */ /* -- page layout --------------------------------------------------------- */ @@ -20,27 +22,53 @@ div.body { } div.sphinxsidebar a:hover { - color: #FF9200; + text-decoration: none !important; } div.sphinxsidebar p { color: #808080; } +/* Home MDAnalysis colour */ +.wy-side-nav-search > a { + color: #343131; +} + +/* Side MDAnalysis version colour */ +.wy-side-nav-search > div.version { + color: #808080; +} + +/* Menubar caption colour */ +div.wy-menu-vertical span.caption-text { + color: #FF9200; +} + +/* Mobile layout menubar option */ +nav.wy-nav-top { + background: #343131; +} + +/* Menu search bar outline (default blue) */ +.wy-side-nav-search input[type="text"] { + border-color: #808080; +} + /* -- body styles --------------------------------------------------------- */ -a { +/* Different coloured links for sidebar vs body) */ +div.rst-content a { color: #FF9200; text-decoration: none; } -a:visited { +div.rst-content a:visited { color: #FF9200; } a:hover { - color: #FF9200; + color: #FF9200 !important; text-decoration: underline; } @@ -66,6 +94,7 @@ a.headerlink:hover { color: #fff; } +/* ------- admonition boxes ------- */ div.admonition { margin: 10px 0px; @@ -75,4 +104,103 @@ div.admonition { div.admonition p.admonition-title { font-size: 100%; font-weight: bolder; -} \ No newline at end of file +} + +/* ----- Tables ----- */ + +/* override table width restrictions */ +/* wrap tables instead of scrolling */ +@media screen and (min-width: 767px) { + + .wy-table-responsive table td, .wy-table-responsive table th { + /* !important prevents the common CSS stylesheets from overriding + this as on RTD they are loaded after this stylesheet */ + white-space: normal !important; + } + + .wy-table-responsive { + overflow: visible !important; + max-width: 100% !important; + } + } + +/* ----- Field lists ------ */ + +.section > dl.field-list { + display: flex; + flex-wrap: wrap; + margin: 0; + padding: 0; +} + +dl.field-list > dt::after { + content: ":"; +} + +.rst-content dl:not(.docutils) dt { + background: none; + color: #000000; + border-top: none; +} + +.section > dl.field-list dt { + margin: 0; + padding: 0; + flex-basis: 20%; + display: block; +} + +.section > dl.field-list > dd { + flex-basis: 70%; + margin: 0; +} + +.section > dl.field-list > dd p { + margin: 0; +} + +/* ----- MDAnalysis coloured elements ------ */ + +.rst-content dl.class dt, .rst-content dl.function dt { + color: #ca6500; + background: #FFEBD0; + border-top: solid 3px #FF9200; +} + +.rst-content .viewcode-link, .rst-content .viewcode-back { + color: #808080; +} + +.rst-content .guilabel { + background: #efefef; + border: 1px solid #808080; +} + + +.rst-content .seealso p.admonition-title { + background: #808080; +} + +.rst-content .seealso { + background: #e3e3e3; +} + +.rst-content .error p.admonition-title, .rst-content .warning p.admonition-title { + background: #F45F4B; +} + +.rst-content .error, .rst-content .warning { + background: #FFEEED; +} + +.rst-content .caution p.admonition-title, .rst-content .note p.admonition-title, .rst-content .important p.admonition-title { + background: #FF9200; +} + +.rst-content .caution, .rst-content .note, .rst-content .important { + background: #FFEBD0; +} + +.rst-content code:not(.xref).literal { + color: #ca6500; +} diff --git a/docs/_static/readable.css b/docs/_static/readable.css deleted file mode 100644 index 1d17021..0000000 --- a/docs/_static/readable.css +++ /dev/null @@ -1,463 +0,0 @@ -/* - * Adapted for combining with alabaster for MDAnalysis. - * To be used as a custom CSS - * - * based on: - * - * readable.css_t - * ~~~~~~~~~~~~~~ - * - * Sphinx stylesheet -- readable theme. - * - * :copyright: Copyright 2013 by Ignacy Sokolowski. - * :license: MIT, see LICENSE for details. - * - */ - - -/* -- page layout --------------------------------------------------------- */ - -body { - font-family: 'Georgia', serif; - font-size: 17px; - margin: 0; - padding: 0; -} - -div.document { - margin: 10px auto 0 auto; - /* max-width: {{ page_width }}; */ -} - -div.documentwrapper { - float: left; - width: 100%; -} - -div.bodywrapper { - /* margin: 0 0 0 {{ theme_sidebarwidth|toint }}px; */ -} - -div.body { - background-color: #ffffff; - color: #3e4349; - padding: 0 30px 30px 30px; -} - -div.footer { - color: #555; - font-size: 14px; - margin: 20px auto 30px auto; - text-align: right; - max-width: 880px; -} - -div.footer a { - color: #444; - text-decoration: underline; -} - -div.related { - padding: 10px 10px; - width: auto; -} - -div.sphinxsidebar { - float: left; - font-size: 14px; - line-height: 1.5em; - margin-left: -100%; - /* width: {{ theme_sidebarwidth|toint }}px; */ -} - -div.sphinxsidebarwrapper { - font-size: 14px; - line-height: 1.5em; - padding: 10px 0 10px 10px; -} - -div.sphinxsidebar h3, -div.sphinxsidebar h4 { - color: #333; - font-size: 24px; - font-weight: normal; - margin: 0 0 5px 0; - padding: 0; -} - -div.sphinxsidebar h4 { - font-size: 1.1em; -} - -div.sphinxsidebar h3 a { - color: #333; -} - -div.sphinxsidebar p { - color: #888; -} - -div.sphinxsidebar p.searchtip { - line-height: 1.4em; -} - -div.sphinxsidebar ul { - color: #000; - margin: 10px 0 20px; - padding: 0; -} - -div.sphinxsidebar a { - color: #444; -} - -div.sphinxsidebar a:hover { - color: #d00; -} - -div.sphinxsidebar input { - border: 1px solid #ccc; - font-family: sans-serif; - font-size: 1em; -} - -/* -- body styles --------------------------------------------------------- */ - -a { - color: #900; - text-decoration: none; -} - -a:visited { - color: #700; -} - -a:hover { - color: #d00; - text-decoration: underline; -} - -hr { - border: 1px solid #b1b4b6; -} - -div.body h1, -div.body h2, -div.body h3, -div.body h4, -div.body h5, -div.body h6 { font-weight: normal; } - -div.body h1, -div.body h2, -div.body h3, -div.body h4 { color: #212224; } -div.body h5 { color: #000; } -div.body h6 { color: #777; } - -div.body h1 { margin: 0 0 10px 0; } -div.body h2, -div.body h3 { margin: 30px 0px 10px 0px; } -div.body h4, -div.body h5, -div.body h6 { margin: 20px 0px 10px 0px; } - -div.body h1 { padding: 0 0 10px 0; } -div.body h2, -div.body h3 { padding: 10px 0 10px 0; } -div.body h4 { padding: 10px 0 10px 0; } -div.body h5, -div.body h6 { padding: 10px 0 0 0; } - -div.body h1, -div.body h2, -div.body h3 { border-bottom: 1px solid #ddd; } -div.body h4 { border-bottom: 1px solid #e5e5e5; } - -div.body h1 { font-size: 230%; } -div.body h2 { font-size: 180%; } -div.body h3 { font-size: 130%; } -div.body h4 { font-size: 110%; } -div.body h5 { font-size: 105%; } -div.body h6 { font-size: 100%; } - -a.headerlink { - color: #c60f0f; - font-size: 0.8em; - padding: 0 4px 0 4px; - text-decoration: none; -} - -a.headerlink:hover { - background-color: #c60f0f; - color: #fff; -} - -div.body ul { - list-style: disc; - margin: 1em 0; - padding-left: 1.3em; -} - -div.body ul ul, div.body ol ul { - margin: .2em 0; - padding-left: 1.2em; -} - -div.body ul li { - padding: 2px 0; -} - -div.body ul.search li { - padding: 5px 0 5px 20px; -} - -div.body ol { - counter-reset: li; - margin-left: 0; - padding-left: 0; -} - -div.body ol ol { - margin: .2em 0; -} - -div.body ol > li { - list-style: none; - margin: 0 0 0 1.9em; - padding: 2px 1px; - position: relative; -} - -div.body ol > li:before { - content: counter(li) "."; - counter-increment: li; - top: -2px; - left: -1.9em; - width: 1.9em; - padding: 4px 0; - position: absolute; - text-align: left; -} - -div.body p, -div.body dd, -div.body li { - line-height: 1.4em; -} - -div.admonition p.admonition-title + p { - display: inline; -} - -div.highlight { - background-color: #fff; -} - -div.important, div.note { - background-color: #eee; - border: 1px solid #ccc; -} - -div.attention, div.caution, div.hint, div.seealso, div.tip { - background-color: #fef9e9; - border: 1px solid #fbe091; -} - -div.topic { - background-color: #eee; -} - -div.danger, div.error, div.warning { - background-color: #ffe4e4; - border: 1px solid #f66; -} - -p.admonition-title { - display: inline; -} - -p.admonition-title:after { - content: ':'; -} - -pre { - background-color: #f5f5f5; - border: 1px solid #C6C9CB; - color: #222; - font-size: 0.75em; - line-height: 1.5em; - margin: 1.5em 0 1.5em 0; - padding: 10px; - box-shadow: 1px 1px 1px #d8d8d8; - -webkit-box-shadow: 1px 1px 1px #d8d8d8; - -moz-box-shadow: 1px 1px 1px #d8d8d8; -} - -pre, tt, code { - font-family: 'Consolas', 'Menlo', 'Deja Vu Sans Mono', 'Bitstream Vera Sans Mono', monospace; -} - -tt, code { - background-color: #ecf0f3; - font-size: 0.85em; -} - -tt.descname, code.descname { - font-size: 0.95em; -} - -tt.xref, a tt, code.xref, a code { - font-weight: normal; -} - -span.pre { - padding: 0 2px; -} - -dl.class, dl.function { - margin-bottom: 50px; -} - -dl.function > dt, -dl.attribute > dt, -dl.classmethod > dt, -dl.method > dt, -dl.class > dt, -dl.exception > dt { - background-color: #f5f5f5; - margin: 25px 0 10px 0; - padding: 1px 10px; -} - -table.docutils { - width: 100%; -} - -table.docutils.footnote { - width: auto; -} - -table.docutils thead, -table.docutils tfoot { - background: #f5f5f5; -} - -table.docutils thead tr th { - color: #000; - font-weight: normal; - padding: 7px 5px; - vertical-align: middle; -} - -table.docutils tbody tr th, -table.docutils tbody tr td { - border-bottom: 0; - border-top: solid 1px #ddd; - padding: 7px 5px; - vertical-align: top; -} -table.docutils tbody tr:last-child th, -table.docutils tbody tr:last-child td { - border-bottom: solid 1px #ddd; -} - -table.docutils thead tr td p, -table.docutils tfoot tr td p, -table.docutils tbody tr td p, -table.docutils thead tr td ul, -table.docutils tfoot tr td ul, -table.docutils tbody tr td ul, -table.docutils thead tr td ol, -table.docutils tfoot tr td ol, -table.docutils tbody tr td ol { - margin: 0 0 .5em; -} -table.docutils thead tr td p.last, -table.docutils tfoot tr td p.last, -table.docutils tbody tr td p.last, -table.docutils thead tr td ul.last, -table.docutils tfoot tr td ul.last, -table.docutils tbody tr td ul.last, -table.docutils thead tr td ol.last, -table.docutils tfoot tr td ol.last, -table.docutils tbody tr td ol.last { - margin-bottom: 0; -} - -.viewcode-back { - font-family: Arial, sans-serif; -} - -div.viewcode-block:target { - background-color: #fef9e9; - border-top: 1px solid #fbe091; - border-bottom: 1px solid #fbe091; -} - -@media screen and (max-width: 870px) { - - div.document { - width: auto; - margin: 0; - } - - div.documentwrapper { - float: none; - } - - div.bodywrapper { - margin: 0; - } - - div.body { - min-height: 0; - padding: 0 20px 30px 20px; - } - - div.footer { - background-color: #333; - color: #888; - margin: 0; - padding: 10px 20px 20px; - text-align: left; - width: auto; - } - - div.footer a { - color: #bbb; - } - - div.footer a:hover { - color: #fff; - } - - div.sphinxsidebar { - background-color: #333; - color: #fff; - float: none; - margin: 0; - padding: 10px 20px; - width: auto; - } - - div.sphinxsidebar h3, - div.sphinxsidebar h4, - div.sphinxsidebar p, - div.sphinxsidebar h3 a { - color: #fff; - } - - div.sphinxsidebar ul { - color: #999; - } - - div.sphinxsidebar a { - color: #aaa; - } - - div.sphinxsidebar a:hover { - color: #fff; - } - -} diff --git a/docs/conf.py b/docs/conf.py index ddea571..e4f9479 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -11,16 +11,19 @@ # All configuration values have a default; values that are commented out # serve to show the default. +import sys, os + # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. -# -# import os -# import sys -# sys.path.insert(0, os.path.abspath('.')) +#sys.path.insert(0, os.path.abspath('.')) + +# make sure sphinx always uses the current branch +sys.path.insert(0, os.path.abspath('..')) +import sphinx_rtd_theme -# -- General configuration ------------------------------------------------ +# -- General configuration ----------------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. # @@ -32,8 +35,9 @@ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.mathjax', 'sphinx.ext.viewcode', 'sphinx.ext.napoleon', 'sphinx.ext.todo', - 'sphinx_sitemap', 'sphinx.ext.autosummary', - 'alabaster'] + 'sphinx.ext.autosummary', + 'sphinx_sitemap', + ] mathjax_path = 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML' @@ -52,13 +56,17 @@ # source_suffix = ['.rst', '.md'] source_suffix = '.rst' +# The encoding of source files. +#source_encoding = 'utf-8-sig' + # The master toctree document. master_doc = 'index' # General information about the project. project = u'MDAnalysisData' -author = u'Oliver Beckstein, Shujie Fan, Micaela Matta, Richard J. Gowers' -copyright = u'2018, ' + author +author = (u'Oliver Beckstein, Shujie Fan, Micaela Matta, ' + u'Richard J. Gowers, Lily Wang') +copyright = u'2018-2020, ' + author # The version info for the project you're documenting, acts as replacement for @@ -72,112 +80,128 @@ # 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 +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' # 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 = ['_build', 'Thumbs.db', '.DS_Store'] +exclude_patterns = [] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = 'default' -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = False +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] -# -- Options for HTML output ---------------------------------------------- +# -- Options for HTML output --------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -# -html_theme = 'alabaster' + +html_theme = 'sphinx_rtd_theme' + +html_theme_path = [ + sphinx_rtd_theme.get_html_theme_path() +] # 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. # -# styles/fonts to match http://mdanalysis.org (see public/css) +# styles/fonts to match https://userguide.mdanalysis.org +# see https://github.com/MDAnalysis/mdanalysis/wiki/MDAnalysis-theme-colours # # /* MDAnalysis orange: #FF9200 */ # /* MDAnalysis gray: #808080 */ # /* MDAnalysis white: #FFFFFF */ # /* MDAnalysis black: #000000 */ -color = {'orange': '#FF9200', - 'gray': '#808080', - 'white': '#FFFFFF', - 'black': '#000000',} - html_theme_options = { - 'logo' : "logos/MDAnalysisData-logo.png", - 'logo_name': True, - 'logo_text_align': "left", - 'description': "Biomolecular simulation datasets", - 'github_user': "MDAnalysis", - 'github_repo': "MDAnalysisData", - 'github_button': False, - 'github_banner': True, - 'extra_nav_links': { - "MDAnalysis": "https://www.mdanalysis.org/", - "alchemtest": "https://alchemtest.readthedocs.io/", - }, - 'show_related': True, - 'fixed_sidebar': False, - 'sidebar_includehidden': True, - 'sidebar_collapse': True, - # style - 'link': color['orange'], - 'link_hover': color['orange'], - 'gray_1': color['gray'], - 'narrow_sidebar_bg': color['gray'], - 'narrow_sidebar_fg': color['white'], - # typography - #'font_size': 17, - 'font_family': "'PT Sans', Helvetica, Arial, 'sans-serif'", - 'head_font_family': "", - 'code_font_size': "smaller", - 'code_font_family': "Menlo, Monaco, 'Courier New', monospace", - 'caption_font_size': "smaller", + '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, } -# Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [alabaster.get_path()] -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -#html_title = None +# options common to RTD and MDAnalysis theme + +# 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". +# For RTD theme: custom.css to override theme defaults. +html_static_path = ['_static'] +html_css_files = ['custom.css'] -# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. -- use theme (only enable if NOT using html_sidebars) -##html_logo = "" +html_logo = "_static/logos/MDAnalysisData-logo.png" # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. html_favicon = "_static/logos/mdanalysis-logo.ico" -# 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'] -# Custom sidebar templates, maps document names to template names. -# alabaster sidebars -html_sidebars = { - '**': [ - 'about.html', - 'navigation.html', - 'relations.html', - 'searchbox.html', - ] -} +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the @@ -219,18 +243,41 @@ author, 'manual'), ] +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None -# -- Options for manual page output --------------------------------------- +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- 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, 'MDAnalysisData', u'MDAnalysisData Documentation', - [author], 1) + author.split(), 1) ] +# If true, show URL addresses after external links. +#man_show_urls = False -# -- Options for Texinfo output ------------------------------------------- + +# -- Options for Texinfo output ------------------------------------------------ # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, @@ -241,10 +288,18 @@ 'Miscellaneous'), ] +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + # Configuration for intersphinx: refer to the Python standard library # and other packages used by MDAnalysis intersphinx_mapping = {'https://docs.python.org/': None, 'https://www.mdanalysis.org/docs/': None, } - From f958ce1941d512618e7b17cfd478960d5e909ec6 Mon Sep 17 00:00:00 2001 From: Oliver Beckstein Date: Wed, 8 Jul 2020 11:39:13 -0700 Subject: [PATCH 2/3] add GoatCounter analytics and Privacy Policy - fix #42 - see https://github.com/MDAnalysis/MDAnalysis.github.io/issues/129 for Privacy Policy --- docs/_templates/footer.html | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 docs/_templates/footer.html diff --git a/docs/_templates/footer.html b/docs/_templates/footer.html new file mode 100644 index 0000000..5fd6ad4 --- /dev/null +++ b/docs/_templates/footer.html @@ -0,0 +1,11 @@ +{% extends "!footer.html" %} + +{% block extrafooter %} +{{ super() }} +

Please see + our Privacy Policy + to learn how MDAnalysis collects data.

+ +
+{% endblock %} From 6a8831081c4066f5b082a721f0f5c04ce4681a4c Mon Sep 17 00:00:00 2001 From: Oliver Beckstein Date: Wed, 8 Jul 2020 12:06:01 -0700 Subject: [PATCH 3/3] update travis to beta v2 see https://docs.travis-ci.com/user/deployment-v2/providers/pages/ --- .travis.yml | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/.travis.yml b/.travis.yml index 76a0e72..2641c72 100644 --- a/.travis.yml +++ b/.travis.yml @@ -29,11 +29,14 @@ after_success: deploy: # stuff related to deploying to gh-pages # GITHUB_TOKEN is set in Travis-CI settings (@orbeckst) - provider: pages - skip_cleanup: true - github_token: $GITHUB_TOKEN + provider: pages:git + strategy: git + cleanup: false + token: $GITHUB_TOKEN on: branch: master python: "3.8" local_dir: build/sphinx/html project_name: MDAnalysisData + # use dpl v2 https://docs.travis-ci.com/user/deployment-v2: + edge: True \ No newline at end of file