Commit Graph

6 Commits

Author SHA1 Message Date
Joey Parrish bbb07b5547
ci: Fix docs build in GitHub Actions (#1109)
The docs build in GitHub Actions broke with the release of jinja 3.1,
which introduced a breaking change that broke the cloud_sptheme sphinx
extension in use by our docs. That extension is not maintained any more,
so there will be no upstream fix. See also
https://foss.heptapod.net/doc-utils/cloud_sptheme/-/issues/47

That extension adds support for table styling (see
https://cloud-sptheme.readthedocs.io/en/latest/lib/cloud_sptheme.ext.table_styling.html),
but we only appear to have one table in the docs currently
(docs/source/options/segment_template_formatting.rst) and it does not
use the options added by the cloud_sptheme extension.

Therefore the best fix for GitHub Actions and any other system running
jinja 3.1 is to remove that extension from our config.
2022-10-21 11:27:58 -07:00
Joey Parrish ac125564b9 build: Fix pylint 2.10 issues, use python3 where possible
The newest pylint release complained about several issues that the
older release did not.  This resolves those issues:

 - removes unneeded "u" prefix from strings
 - adds "encoding" parameter for all open() calls
 - because "encoding" is a python3-only parameter, use python3 in all
   the scripts that we control

Unfortunately, python2 is required for any scripts that import modules
from the ancient Chromium build system we're using (referenced by
DEPS), as well as kokoro scripts.

Change-Id: I2e9f97af508efe58b5a71de21740e59b1528affd
2021-08-24 12:27:03 -07:00
KongQun Yang 6c8ad30217 Update Sphinx config for markdown handling
The config format has changed in v3.0 in the handling of markdown.

See https://www.sphinx-doc.org/en/master/usage/markdown.html.

Change-Id: I3f2dad962824e1d5f410f8420795c68715b03635
2021-04-09 21:18:06 -07:00
KongQun Yang 75e1fc3175 Added architecture diagram
Also remove outdated design.md.

Change-Id: I237b374a2fffe348b1daf5f8d1c37c57b4898fde
2017-12-01 00:29:50 +00:00
KongQun Yang fcf2873211 Updated style for option list and field list
This makes them looking better.

Change-Id: Icf3827a779bda470ed6a6ac8e56d2daa19e773a5
2017-09-19 14:52:25 -07:00
KongQun Yang c64b92bf8f Sphinxdoc configure and other main pages
Build sphinx docs in docs/ directory:

$ make html

The outputs are created in out/sphinx directory.

Change-Id: I040915a30aa52d41b18e04741e45622fa61244f6
2017-09-19 14:48:52 -07:00