From dda03f54215d810d4590eb4883f7b93e9e802fb1 Mon Sep 17 00:00:00 2001 From: Ivan Kravets Date: Wed, 28 Apr 2021 13:05:28 +0300 Subject: [PATCH] Refactor docs to be deployed as a static content --- .gitignore | 1 + Makefile | 183 ++-------------- _ext/redirects.py | 127 +++++++++++ _static/css/extra.css | 3 +- _templates/layout.html | 14 ++ _templates/{footer.html => navigation.html} | 8 - _templates/pio-versions.html | 26 +++ conf.py | 166 ++++++++------- make.bat | 225 +------------------- redirects.txt | 86 ++++++++ 10 files changed, 366 insertions(+), 473 deletions(-) create mode 100644 _ext/redirects.py create mode 100644 _templates/layout.html rename _templates/{footer.html => navigation.html} (93%) create mode 100644 _templates/pio-versions.html create mode 100644 redirects.txt diff --git a/.gitignore b/.gitignore index e35d8850c9..3dc4a669bb 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ _build +_ext/__pycache__ diff --git a/Makefile b/Makefile index f5ea2385df..d4bb2cbb9e 100644 --- a/Makefile +++ b/Makefile @@ -1,177 +1,20 @@ -# Makefile for Sphinx documentation +# Minimal makefile for Sphinx documentation # -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -PAPER = +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = . BUILDDIR = _build -# User-friendly check for sphinx-build -ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) -$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) -endif - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . -# the i18n builder cannot share the environment and doctrees with the others -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . - -.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext - +# Put it first so that "make" without argument is like "make help". help: - @echo "Please use \`make ' where is one of" - @echo " html to make standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " singlehtml to make a single large HTML file" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " devhelp to make HTML files and a Devhelp project" - @echo " epub to make an epub" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" - @echo " text to make text files" - @echo " man to make manual pages" - @echo " texinfo to make Texinfo files" - @echo " info to make Texinfo files and run them through makeinfo" - @echo " gettext to make PO message catalogs" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " xml to make Docutils-native XML files" - @echo " pseudoxml to make pseudoxml-XML files for display purposes" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - -clean: - rm -rf $(BUILDDIR)/* - -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/PlatformIO.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PlatformIO.qhc" - -devhelp: - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp - @echo - @echo "Build finished." - @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/PlatformIO" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/PlatformIO" - @echo "# devhelp" - -epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make' in that directory to run these through (pdf)latex" \ - "(use \`make latexpdf' here to do that automatically)." - -latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through pdflatex..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -latexpdfja: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through platex and dvipdfmx..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -text: - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(BUILDDIR)/text." - -man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man - @echo - @echo "Build finished. The manual pages are in $(BUILDDIR)/man." - -texinfo: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo - @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." - @echo "Run \`make' in that directory to run these through makeinfo" \ - "(use \`make info' here to do that automatically)." - -info: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo "Running Texinfo files through makeinfo..." - make -C $(BUILDDIR)/texinfo info - @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." - -gettext: - $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale - @echo - @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." - -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) -xml: - $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml - @echo - @echo "Build finished. The XML files are in $(BUILDDIR)/xml." +.PHONY: help Makefile -pseudoxml: - $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml - @echo - @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/_ext/redirects.py b/_ext/redirects.py new file mode 100644 index 0000000000..b436fd7f6e --- /dev/null +++ b/_ext/redirects.py @@ -0,0 +1,127 @@ +# Copyright (c) 2014-present PlatformIO +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import os +from string import Template + + +REDIRECT_TEMPLATE = Template( + r""" + + + + Redirecting… + + + + + + + +

Redirecting…

+

Click here if you are not redirected.

+ + +""" +) + + +def load_redirects(src_dir): + redirects_txt = os.path.join(src_dir, "redirects.txt") + assert os.path.isfile(redirects_txt) + result = {} + with open(redirects_txt) as fp: + for line in fp.readlines(): + line = line.strip() + skip_conds = [ + not line, + not line.startswith("/"), + "->" not in line, + ] + if any(skip_conds): + continue + from_path, to_path = line.split("->") + from_path = from_path.strip() + to_path = to_path.strip() + assert from_path.endswith(".html") + assert to_path.endswith(".html") + result[from_path] = to_path + return result + + +def build_redirect_pages(app, exception): + if app.builder.name != "html": + return + is_latest = app.config.html_context.get("is_latest") + redirects = load_redirects(app.srcdir) + for from_path, to_path in redirects.items(): + out_dir = app.outdir + if os.path.dirname(from_path) != "/": + out_dir = os.path.join(out_dir, os.path.dirname(from_path)[1:]) + os.makedirs(out_dir, exist_ok=True) + with open(os.path.join(out_dir, os.path.basename(from_path)), "w") as fp: + fp.write( + REDIRECT_TEMPLATE.substitute( + redirect_url="%s/en/%s%s" + % ( + app.config.html_baseurl, + ("latest" if is_latest else "stable"), + to_path, + ) + ).strip() + ) + print("Built %d redirect pages" % len(redirects)) + + +def build_legacy_rtd_pages(app, exception): + if app.builder.name != "html": + return + for root, dirs, files in os.walk(app.outdir): + for name in files: + if not name.endswith(".html"): + continue + out_dir = os.path.join(os.path.dirname(app.outdir), "rtdpage") + relative_dir = root[len(os.path.commonpath([app.outdir, root])) :] or "/" + if relative_dir != "/": + out_dir = os.path.join(out_dir, relative_dir[1:]) + os.makedirs(out_dir, exist_ok=True) + with open(os.path.join(out_dir, name), "w") as fp: + fp.write( + REDIRECT_TEMPLATE.substitute( + redirect_url="%s/en/latest%s%s" + % ( + app.config.html_baseurl, + relative_dir, + name, + ) + ).strip() + ) + + +def setup(app): + app.connect("build-finished", build_redirect_pages) + app.connect("build-finished", build_legacy_rtd_pages) + return { + "parallel_read_safe": True, + "parallel_write_safe": True, + } diff --git a/_static/css/extra.css b/_static/css/extra.css index 913d0622da..5e27484bdd 100644 --- a/_static/css/extra.css +++ b/_static/css/extra.css @@ -529,8 +529,7 @@ fieldset[disabled] .navbar-inverse .btn-link:focus { max-width: 1000px !important; } -.wy-side-scroll .wy-side-nav-search .icon, -.wy-side-scroll .wy-side-nav-search .version { +.wy-side-scroll .wy-side-nav-search .icon { display: none; visibility: none; } diff --git a/_templates/layout.html b/_templates/layout.html new file mode 100644 index 0000000000..7728642c51 --- /dev/null +++ b/_templates/layout.html @@ -0,0 +1,14 @@ +{% extends "!layout.html" %} + +{% block extrahead %} +{{ super() }} + + + +{% endblock %} + +{% block footer %} +{% include "pio-versions.html" %} +{{ super() }} +{% include "navigation.html" %} +{% endblock %} \ No newline at end of file diff --git a/_templates/footer.html b/_templates/navigation.html similarity index 93% rename from _templates/footer.html rename to _templates/navigation.html index d89a0c39f3..99961d7fdd 100644 --- a/_templates/footer.html +++ b/_templates/navigation.html @@ -1,9 +1,3 @@ -{% extends "!footer.html" %} - -{% block extrafooter %} - - - -{{ super() }} -{% endblock %} diff --git a/_templates/pio-versions.html b/_templates/pio-versions.html new file mode 100644 index 0000000000..12cfe1788f --- /dev/null +++ b/_templates/pio-versions.html @@ -0,0 +1,26 @@ +{# Keep in sync with https://github.com/readthedocs/sphinx_rtd_theme/blob/master/sphinx_rtd_theme/versions.html #} +{# Add rst-badge after rst-versions for small badge style. #} +
+ + Documentation + v{{ release }} ({{ "latest" if is_latest else "stable" }}) + + +
+
+
{{ _('Versions') }}
+ {% for slug, url in versions %} +
{{ slug }}
+ {% endfor %} +
+
+
{{ _('On Github') }}
+
{{ _('View') }}
+
{{ _('Edit') }}
+
+
+
{{ _('Search') }}
+
{% include "searchbox.html" %}
+
+
+
diff --git a/conf.py b/conf.py index 2532b30756..7df6432d98 100644 --- a/conf.py +++ b/conf.py @@ -15,181 +15,196 @@ import os import sys +import sphinx_rtd_theme + # 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. sys.path.insert(0, os.path.abspath(os.pardir)) +sys.path.append(os.path.join(os.path.dirname(os.path.realpath(__file__)), "_ext")) # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' +# needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = [] +extensions = ["redirects", "sphinx.ext.githubpages", "notfound.extension"] # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +templates_path = ["_templates"] # The suffix of source filenames. -source_suffix = '.rst' +source_suffix = ".rst" # The encoding of source files. -#source_encoding = 'utf-8-sig' +# source_encoding = 'utf-8-sig' # The master toctree document. -master_doc = 'index' +master_doc = "index" # General information about the project. -project = u'PlatformIO' -copyright = u'2014-present, PlatformIO' +project = u"PlatformIO" +copyright = u"2014-present, PlatformIO" # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # import platformio + # The short X.Y version. -version = '.'.join(map(str, platformio.VERSION[0:2])) +version = ".".join(map(str, platformio.VERSION[0:2])) # The full version, including alpha/beta/rc tags. release = platformio.__version__ +is_latest = not str(platformio.VERSION[2]).isdigit() # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -#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 = '' +# today = '' # Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' +# today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. -exclude_patterns = ['_build', '**/*_extra.rst'] +exclude_patterns = ["_build", "**/*_extra.rst"] + +# FIXME: +exclude_patterns += ["boards", "frameworks", "platforms", "plus"] # The reST default role (used for this markup: `text`) to use for all # documents. -#default_role = None +# default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True +# 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 +# add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. -#show_authors = False +# show_authors = False # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'pastie' +pygments_style = "pastie" # A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] +# modindex_common_prefix = [] # If true, keep warnings as "system message" paragraphs in the built documents. -#keep_warnings = False +# keep_warnings = False # -- 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 = 'default' +html_theme = "sphinx_rtd_theme" # 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. -#html_theme_options = {} +html_theme_options = { + "analytics_id": "UA-1768265-7", + "logo_only": True, + "display_version": False, +} # Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] +html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". -#html_title = None +html_title = "%s %s documentation" % ( + project, + ("latest" if is_latest else "v" + version), +) # A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None +# html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. -#html_logo = '_static/images/platformio-logo.png' +# html_logo = '_static/images/platformio-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/images/favicon.ico' +html_favicon = "_static/images/favicon.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'] +html_static_path = ["_static"] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied # directly to the root of the documentation. -#html_extra_path = [] +# html_extra_path = [] # 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' +# 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 +# html_use_smartypants = True # Custom sidebar templates, maps document names to template names. -#html_sidebars = {} +# html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. -#html_additional_pages = {} +# html_additional_pages = {} # If false, no module index is generated. -#html_domain_indices = True +# html_domain_indices = True # If false, no index is generated. -#html_use_index = True +# html_use_index = True # If true, the index is split into individual pages for each letter. -#html_split_index = False +# html_split_index = False # If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True +# html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True +html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = 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 # base URL from which the finished HTML is served. -#html_use_opensearch = '' +# html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None +# html_file_suffix = None -# Output file base name for HTML help builder. -htmlhelp_basename = 'PlatformIOdoc' +# The base URL which points to the root of the HTML documentation +html_baseurl = "https://docs.platformio.org" +# Output file base name for HTML help builder. +htmlhelp_basename = "PlatformIOdoc" # -- Options for LaTeX output --------------------------------------------- latex_elements = { # The paper size ('letterpaper' or 'a4paper'). #'papersize': 'letterpaper', - # The font size ('10pt', '11pt' or '12pt'). #'pointsize': '10pt', - # Additional stuff for the LaTeX preamble. #'preamble': '', } @@ -198,42 +213,38 @@ # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - ('index', 'PlatformIO.tex', u'PlatformIO Documentation', - u'PlatformIO', 'manual'), + ("index", "PlatformIO.tex", u"PlatformIO Documentation", u"PlatformIO", "manual"), ] # The name of an image file (relative to this directory) to place at the top of # the title page. -#latex_logo = None +# latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. -#latex_use_parts = False +# latex_use_parts = False # If true, show page references after internal links. -#latex_show_pagerefs = False +# latex_show_pagerefs = False # If true, show URL addresses after external links. -#latex_show_urls = False +# latex_show_urls = False # Documents to append as an appendix to all manuals. -#latex_appendices = [] +# latex_appendices = [] # If false, no module index is generated. -#latex_domain_indices = True +# 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 = [ - ('index', 'platformio', u'PlatformIO Documentation', - [u'PlatformIO'], 1) -] +man_pages = [("index", "platformio", u"PlatformIO Documentation", [u"PlatformIO"], 1)] # If true, show URL addresses after external links. -#man_show_urls = False +# man_show_urls = False # -- Options for Texinfo output ------------------------------------------- @@ -242,35 +253,31 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'PlatformIO', u'PlatformIO Documentation', - u'PlatformIO', 'PlatformIO', 'One line description of project.', - 'Miscellaneous'), + ( + "index", + "PlatformIO", + u"PlatformIO Documentation", + u"PlatformIO", + "PlatformIO", + "One line description of project.", + "Miscellaneous", + ), ] # Documents to append as an appendix to all manuals. -#texinfo_appendices = [] +# texinfo_appendices = [] # If false, no module index is generated. -#texinfo_domain_indices = True +# texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' +# texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. -#texinfo_no_detailmenu = False - +# texinfo_no_detailmenu = False # Example configuration for intersphinx: refer to the Python standard library. -#intersphinx_mapping = {'http://docs.python.org/': None} - -# Read the Docs Sphinx Theme patch -# on_rtd is whether we are on readthedocs.org, -# this line of code grabbed from docs.readthedocs.org -on_rtd = os.environ.get('READTHEDOCS', None) == 'True' -if not on_rtd: # only import and set the theme if we're building docs locally - import sphinx_rtd_theme - html_theme = 'sphinx_rtd_theme' - html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] +# intersphinx_mapping = {'http://docs.python.org/': None} # A timeout value, in seconds, for the linkcheck builder # http://sphinx-doc.org/config.html#confval-linkcheck_timeout @@ -282,5 +289,10 @@ "github_user": "platformio", "github_repo": "platformio-docs", "github_version": "develop", - "conf_py_path": "/" + "conf_py_path": "/", + "is_latest": is_latest, + "versions": [ + ("latest", "/en/"), + ("stable", "/en/stable/"), + ], } diff --git a/make.bat b/make.bat index 304543b6a3..2119f51099 100644 --- a/make.bat +++ b/make.bat @@ -1,53 +1,18 @@ @ECHO OFF +pushd %~dp0 + REM Command file for Sphinx documentation if "%SPHINXBUILD%" == "" ( set SPHINXBUILD=sphinx-build ) +set SOURCEDIR=. set BUILDDIR=_build -set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . -set I18NSPHINXOPTS=%SPHINXOPTS% . -if NOT "%PAPER%" == "" ( - set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% - set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% -) if "%1" == "" goto help -if "%1" == "help" ( - :help - echo.Please use `make ^` where ^ is one of - echo. html to make standalone HTML files - echo. dirhtml to make HTML files named index.html in directories - echo. singlehtml to make a single large HTML file - echo. pickle to make pickle files - echo. json to make JSON files - echo. htmlhelp to make HTML files and a HTML help project - echo. qthelp to make HTML files and a qthelp project - echo. devhelp to make HTML files and a Devhelp project - echo. epub to make an epub - echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter - echo. text to make text files - echo. man to make manual pages - echo. texinfo to make Texinfo files - echo. gettext to make PO message catalogs - echo. changes to make an overview over all changed/added/deprecated items - echo. xml to make Docutils-native XML files - echo. pseudoxml to make pseudoxml-XML files for display purposes - echo. linkcheck to check all external links for integrity - echo. doctest to run all doctests embedded in the documentation if enabled - goto end -) - -if "%1" == "clean" ( - for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i - del /q /s %BUILDDIR%\* - goto end -) - - -%SPHINXBUILD% 2> nul +%SPHINXBUILD% >NUL 2>NUL if errorlevel 9009 ( echo. echo.The 'sphinx-build' command was not found. Make sure you have Sphinx @@ -60,183 +25,11 @@ if errorlevel 9009 ( exit /b 1 ) -if "%1" == "html" ( - %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/html. - goto end -) - -if "%1" == "dirhtml" ( - %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. - goto end -) - -if "%1" == "singlehtml" ( - %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. - goto end -) - -if "%1" == "pickle" ( - %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can process the pickle files. - goto end -) - -if "%1" == "json" ( - %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can process the JSON files. - goto end -) - -if "%1" == "htmlhelp" ( - %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can run HTML Help Workshop with the ^ -.hhp project file in %BUILDDIR%/htmlhelp. - goto end -) - -if "%1" == "qthelp" ( - %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can run "qcollectiongenerator" with the ^ -.qhcp project file in %BUILDDIR%/qthelp, like this: - echo.^> qcollectiongenerator %BUILDDIR%\qthelp\PlatformIO.qhcp - echo.To view the help file: - echo.^> assistant -collectionFile %BUILDDIR%\qthelp\PlatformIO.ghc - goto end -) - -if "%1" == "devhelp" ( - %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. - goto end -) - -if "%1" == "epub" ( - %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The epub file is in %BUILDDIR%/epub. - goto end -) - -if "%1" == "latex" ( - %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. - goto end -) - -if "%1" == "latexpdf" ( - %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex - cd %BUILDDIR%/latex - make all-pdf - cd %BUILDDIR%/.. - echo. - echo.Build finished; the PDF files are in %BUILDDIR%/latex. - goto end -) - -if "%1" == "latexpdfja" ( - %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex - cd %BUILDDIR%/latex - make all-pdf-ja - cd %BUILDDIR%/.. - echo. - echo.Build finished; the PDF files are in %BUILDDIR%/latex. - goto end -) - -if "%1" == "text" ( - %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The text files are in %BUILDDIR%/text. - goto end -) - -if "%1" == "man" ( - %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The manual pages are in %BUILDDIR%/man. - goto end -) - -if "%1" == "texinfo" ( - %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. - goto end -) +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end -if "%1" == "gettext" ( - %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The message catalogs are in %BUILDDIR%/locale. - goto end -) - -if "%1" == "changes" ( - %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes - if errorlevel 1 exit /b 1 - echo. - echo.The overview file is in %BUILDDIR%/changes. - goto end -) - -if "%1" == "linkcheck" ( - %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck - if errorlevel 1 exit /b 1 - echo. - echo.Link check complete; look for any errors in the above output ^ -or in %BUILDDIR%/linkcheck/output.txt. - goto end -) - -if "%1" == "doctest" ( - %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest - if errorlevel 1 exit /b 1 - echo. - echo.Testing of doctests in the sources finished, look at the ^ -results in %BUILDDIR%/doctest/output.txt. - goto end -) - -if "%1" == "xml" ( - %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The XML files are in %BUILDDIR%/xml. - goto end -) - -if "%1" == "pseudoxml" ( - %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml. - goto end -) +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% :end +popd diff --git a/redirects.txt b/redirects.txt new file mode 100644 index 0000000000..391822acf2 --- /dev/null +++ b/redirects.txt @@ -0,0 +1,86 @@ +/userguide/remote/cmd_update.html -> /core/userguide/remote/cmd_update.html +/userguide/remote/cmd_test.html -> /core/userguide/remote/cmd_test.html +/userguide/remote/cmd_run.html -> /core/userguide/remote/cmd_run.html +/userguide/remote/cmd_device.html -> /core/userguide/remote/cmd_device.html +/userguide/remote/cmd_agent.html -> /core/userguide/remote/cmd_agent.html +/userguide/remote/index.html -> /core/userguide/remote/index.html +/userguide/platforms/cmd_update.html -> /core/userguide/platforms/cmd_update.html +/userguide/platforms/cmd_uninstall.html -> /core/userguide/platforms/cmd_uninstall.html +/userguide/platforms/cmd_show.html -> /core/userguide/platforms/cmd_show.html +/userguide/platforms/cmd_search.html -> /core/userguide/platforms/cmd_search.html +/userguide/platforms/cmd_list.html -> /core/userguide/platforms/cmd_list.html +/userguide/platforms/cmd_install.html -> /core/userguide/platforms/cmd_install.html +/userguide/platforms/cmd_frameworks.html -> /core/userguide/platforms/cmd_frameworks.html +/userguide/platforms/index.html -> /core/userguide/platforms/index.html +/userguide/cmd_upgrade.html -> /core/userguide/cmd_upgrade.html +/userguide/cmd_update.html -> /core/userguide/cmd_update.html +/userguide/cmd_test.html -> /core/userguide/cmd_test.html +/userguide/cmd_settings.html -> /core/userguide/cmd_settings.html +/userguide/cmd_run.html -> /core/userguide/cmd_run.html +/userguide/project/cmd_init.html -> /core/userguide/project/cmd_init.html +/userguide/project/cmd_config.html -> /core/userguide/project/cmd_config.html +/userguide/project/index.html -> /core/userguide/project/index.html +/userguide/lib/cmd_builtin.html -> /core/userguide/lib/cmd_builtin.html +/userguide/lib/cmd_install.html -> /core/userguide/lib/cmd_install.html +/userguide/lib/cmd_list.html -> /core/userguide/lib/cmd_list.html +/userguide/lib/cmd_register.html -> /core/userguide/lib/cmd_register.html +/userguide/lib/cmd_search.html -> /core/userguide/lib/cmd_search.html +/userguide/lib/cmd_show.html -> /core/userguide/lib/cmd_show.html +/userguide/lib/cmd_stats.html -> /core/userguide/lib/cmd_stats.html +/userguide/lib/cmd_uninstall.html -> /core/userguide/lib/cmd_uninstall.html +/userguide/lib/cmd_update.html -> /core/userguide/lib/cmd_update.html +/userguide/lib/index.html -> /core/userguide/lib/index.html +/userguide/cmd_home.html -> /core/userguide/cmd_home.html +/userguide/cmd_debug.html -> /core/userguide/cmd_debug.html +/userguide/cmd_ci.html -> /core/userguide/cmd_ci.html +/userguide/cmd_check.html -> /core/userguide/cmd_check.html +/userguide/cmd_boards.html -> /core/userguide/cmd_boards.html +/userguide/account/cmd_token.html -> /core/userguide/account/cmd_token.html +/userguide/account/cmd_show.html -> /core/userguide/account/cmd_show.html +/userguide/account/cmd_register.html -> /core/userguide/account/cmd_register.html +/userguide/account/cmd_password.html -> /core/userguide/account/cmd_password.html +/userguide/account/cmd_logout.html -> /core/userguide/account/cmd_logout.html +/userguide/account/cmd_login.html -> /core/userguide/account/cmd_login.html +/userguide/account/cmd_forgot.html -> /core/userguide/account/cmd_forgot.html +/userguide/device/cmd_monitor.html -> /core/userguide/device/cmd_monitor.html +/userguide/account/index.html -> /core/userguide/account/index.html +/userguide/demo.html -> /core/userguide/demo.html +/userguide/index.html -> /core/userguide/index.html +/quickstart.html -> /core/quickstart.html +/migration.html -> /core/migration.html +/history.html -> /core/history.html +/installation.html -> /core/installation.html +/core.html -> /core/index.html +/ide.html -> /integration/ide/index.html +/ide/vscode.html -> /integration/ide/vscode.html +/ide/visualstudio.html -> /integration/ide/visualstudio.html +/ide/vim.html -> /integration/ide/vim.html +/ide/sublimetext.html -> /integration/ide/sublimetext.html +/ide/qtcreator.html -> /integration/ide/qtcreator.html +/ide/pioide.html -> /integration/ide/pioide.html +/ide/netbeans.html -> /integration/ide/netbeans.html +/ide/emacs.html -> /integration/ide/emacs.html +/ide/eclipseche.html -> /integration/ide/eclipseche.html +/ide/eclipse.html -> /integration/ide/eclipse.html +/ide/codeblocks.html -> /integration/ide/codeblocks.html +/ide/codeanywhere.html -> /integration/ide/codeanywhere.html +/ide/cloud9.html -> /integration/ide/cloud9.html +/ide/clion.html -> /integration/ide/clion.html +/ide/atom.html -> /integration/ide/atom.html +/ci/travis.html -> /integration/ci/travis.html +/ci/shippable.html -> /integration/ci/shippable.html +/ci/jenkins.html -> /integration/ci/jenkins.html +/ci/gitlab.html -> /integration/ci/gitlab.html +/ci/github-actions.html -> /integration/ci/github-actions.html +/ci/drone.html -> /integration/ci/drone.html +/ci/circleci.html -> /integration/ci/circleci.html +/ci/appveyor.html -> /integration/ci/appveyor.html +/ci/index.html -> /integration/ci/index.html +/userguide/cmd_device.html -> /core/userguide/device/index.html +/projectconf.html -> projectconf/index.html +/userguide/cmd_init.html -> /userguide/project/cmd_init.html +/projectconf/section_env_board.html -> /projectconf/section_env_platform.html +/projectconf/section_env_general.html -> /projectconf/section_env_platform.html +/userguide/cmd_serialports.html -> /userguide/cmd_device.html +/platforms/unit_testing.html -> /plus/unit-testing.html +/platforms/espressif.html -> /platforms/espressif8266.html