Mirror-Tools
/
shaka-packager
mirror of https://github.com/shaka-project/shaka-packager.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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
This commit is contained in:
KongQun Yang 2021-04-09 21:15:40 -07:00
parent f6c02e629d
commit 6c8ad30217
2 changed files with 2 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/source/build_instructions.md
View File

@ -67,12 +67,10 @@ Download the
[depot_tools bundle](https://storage.googleapis.com/chrome-infra/depot_tools.zip) [depot_tools bundle](https://storage.googleapis.com/chrome-infra/depot_tools.zip)
and extract it somewhere. and extract it somewhere.
*** note **WARNING: DO NOT** use drag-n-drop or copy-n-paste extract from Explorer,
**Warning:** **DO NOT** use drag-n-drop or copy-n-paste extract from Explorer,
this will not extract the hidden “.git” folder which is necessary for this will not extract the hidden “.git” folder which is necessary for
depot_tools to autoupdate itself. You can use “Extract all…” from the context depot_tools to autoupdate itself. You can use “Extract all…” from the context
menu though. menu though.
***
Add depot_tools to the start of your PATH (must be ahead of any installs of Add depot_tools to the start of your PATH (must be ahead of any installs of
Python). Assuming you unzipped the bundle to C:\src\depot_tools, open: Python). Assuming you unzipped the bundle to C:\src\depot_tools, open:

7
docs/source/conf.py
View File

@ -16,8 +16,6 @@ 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. documentation root, use os.path.abspath to make it absolute, like shown here.
""" """
from recommonmark.parser import CommonMarkParser
# sys.path.append('breathe/') # sys.path.append('breathe/')
# -- General configuration ------------------------------------------------ # -- General configuration ------------------------------------------------
@ -36,6 +34,7 @@ extensions = ['sphinx.ext.autodoc',
'sphinx.ext.viewcode', 'sphinx.ext.viewcode',
'sphinx.ext.githubpages', 'sphinx.ext.githubpages',
'sphinxcontrib.plantuml', 'sphinxcontrib.plantuml',
'recommonmark',
'cloud_sptheme.ext.table_styling', 'cloud_sptheme.ext.table_styling',
'breathe'] 'breathe']
@ -47,10 +46,6 @@ breathe_default_members = ('members',)
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ['_templates']
source_parsers = {
'.md': CommonMarkParser,
}
# The suffix(es) of source filenames. # The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string: # You can specify multiple suffix as a list of string:
source_suffix = ['.rst', '.md'] source_suffix = ['.rst', '.md']