From 86acd842cebe0174870d399228bb25c1693ae8f3 Mon Sep 17 00:00:00 2001 From: David Lord Date: Sat, 28 Jul 2018 14:00:39 -0700 Subject: [PATCH] experimental readthedocs build --- docs/conf.py | 26 +++++++++----------------- docs/requirements.txt | 3 +++ 2 files changed, 12 insertions(+), 17 deletions(-) create mode 100644 docs/requirements.txt diff --git a/docs/conf.py b/docs/conf.py index 04172441..91159bed 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -3,8 +3,7 @@ from __future__ import print_function import inspect import re - -from pallets_sphinx_themes import DocVersion, ProjectLink, get_version +from pallets_sphinx_themes import ProjectLink, get_version # Project -------------------------------------------------------------- @@ -21,6 +20,7 @@ extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinxcontrib.log_cabinet', + 'pallets_sphinx_themes', ] intersphinx_mapping = { @@ -39,42 +39,34 @@ intersphinx_mapping = { html_theme = 'flask' html_context = { 'project_links': [ - ProjectLink('Donate to Pallets', 'https://psfmember.org/civicrm/contribute/transact?reset=1&id=20'), + ProjectLink('Donate to Pallets', 'https://www.palletsprojects.com/donate'), ProjectLink('Flask Website', 'https://palletsprojects.com/p/flask/'), ProjectLink('PyPI releases', 'https://pypi.org/project/Flask/'), ProjectLink('Source Code', 'https://github.com/pallets/flask/'), - ProjectLink( - 'Issue Tracker', 'https://github.com/pallets/flask/issues/'), - ], - 'versions': [ - DocVersion('dev', 'Development', 'unstable'), - DocVersion('1.0', 'Flask 1.0', 'stable'), - DocVersion('0.12', 'Flask 0.12'), + ProjectLink('Issue Tracker', 'https://github.com/pallets/flask/issues/'), ], - 'canonical_url': 'http://flask.pocoo.org/docs/{}/'.format(version), - 'carbon_ads_args': 'zoneid=1673&serve=C6AILKT&placement=pocooorg', } html_sidebars = { 'index': [ 'project.html', 'versions.html', - 'carbon_ads.html', 'searchbox.html', ], '**': [ 'localtoc.html', 'relations.html', 'versions.html', - 'carbon_ads.html', 'searchbox.html', ] } +singlehtml_sidebars = [ + "project.html", + "versions.html", + "localtoc.html", +] html_static_path = ['_static'] html_favicon = '_static/flask-favicon.ico' html_logo = '_static/flask.png' -html_additional_pages = { - '404': '404.html', -} html_show_sourcelink = False # LaTeX ---------------------------------------------------------------- diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..78efda5b --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,3 @@ +sphinx +sphinxcontrib-log-cabinet +https://github.com/pallets/pallets-sphinx-themes/archive/master.zip