luke
/
prjxray
mirror of https://github.com/openXC7/prjxray.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1505 from antmicro/fix_links 

Fix links generation for markdown-code-symlinks
This commit is contained in:
Robert Winkler 2020-12-15 16:55:51 +01:00 committed by GitHub
parent 483a89c292 310292cf58
commit 291d9b91d3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/Makefile
View File

@ -69,5 +69,5 @@ links: fuzzers-links minitests-links
# Catch-all target: route all unknown targets to Sphinx using the new # Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile links %: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

11
docs/conf.py
View File

@ -30,6 +30,8 @@ import recommonmark
# #
import os import os
import sys import sys
import subprocess
sys.path.insert(0, os.path.abspath('.')) sys.path.insert(0, os.path.abspath('.'))
from markdown_code_symlinks import LinkParser, MarkdownSymlinksDomain from markdown_code_symlinks import LinkParser, MarkdownSymlinksDomain
@ -37,7 +39,7 @@ from markdown_code_symlinks import LinkParser, MarkdownSymlinksDomain
# If your documentation needs a minimal Sphinx version, state it here. # If your documentation needs a minimal Sphinx version, state it here.
# #
# needs_sphinx = '1.0' needs_sphinx = '3.0'
# Add any Sphinx extension module names here, as strings. They can be # Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@ -51,7 +53,8 @@ extensions = [
'sphinx.ext.imgmath', 'sphinx.ext.imgmath',
'sphinx.ext.napoleon', 'sphinx.ext.napoleon',
'sphinx.ext.todo', 'sphinx.ext.todo',
'sphinx_markdown_tables' 'sphinx_markdown_tables',
'recommonmark'
] ]
# yapf: enable # yapf: enable
@ -86,7 +89,6 @@ if not on_rtd:
else: else:
docs_dir = os.path.abspath(os.path.dirname(__file__)) docs_dir = os.path.abspath(os.path.dirname(__file__))
print("Docs dir is:", docs_dir) print("Docs dir is:", docs_dir)
import subprocess
subprocess.call('git fetch origin --unshallow', cwd=docs_dir, shell=True) subprocess.call('git fetch origin --unshallow', cwd=docs_dir, shell=True)
subprocess.check_call('git fetch origin --tags', cwd=docs_dir, shell=True) subprocess.check_call('git fetch origin --tags', cwd=docs_dir, shell=True)
subprocess.check_call('make links', cwd=docs_dir, shell=True) subprocess.check_call('make links', cwd=docs_dir, shell=True)
@ -268,6 +270,9 @@ intersphinx_mapping = {'https://docs.python.org/': None}
def setup(app): def setup(app):
# Generate links for markdown-code-symlinks
subprocess.check_call("make links", shell=True)
github_code_repo = 'https://github.com/SymbiFlow/prjxray/' github_code_repo = 'https://github.com/SymbiFlow/prjxray/'
github_code_branch = 'blob/master/' github_code_branch = 'blob/master/'

3
docs/requirements.txt
View File

@ -1,8 +1,7 @@
sphinx_materialdesign_theme sphinx_materialdesign_theme
docutils docutils
# Disabling direct sphinx because of https://github.com/pypa/pip/issues/9031 sphinx>=3.0
# sphinx
sphinx-autobuild sphinx-autobuild
breathe breathe