Skip to content

Commit 54ac914

Browse files
committed
docs: add btd.yml and Makefile
1 parent 9809344 commit 54ac914

File tree

3 files changed

+31
-2
lines changed

3 files changed

+31
-2
lines changed

.btd.yml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
input: docs
2+
output: docs/_build
3+
requirements: requirements.txt
4+
target: gh-pages
5+
formats: [ html ]
6+
theme: https://codeload.github.com/buildthedocs/sphinx.theme/tar.gz/v1

docs/Makefile

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
SPHINXOPTS =
2+
SPHINXBUILD = sphinx-build
3+
PAPER =
4+
BUILDDIR = _build
5+
6+
PAPEROPT_a4 = -D latex_paper_size=a4
7+
PAPEROPT_letter = -D latex_paper_size=letter
8+
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees -T -D language=en $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
9+
10+
#---
11+
12+
man:
13+
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
14+
15+
#---
16+
17+
html:
18+
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
19+
20+
#---
21+
22+
latex:
23+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex

docs/conf.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,7 @@
1313
extensions = [
1414
"sphinx.ext.extlinks",
1515
"sphinx.ext.intersphinx",
16-
"sphinx.ext.todo",
17-
"sphinxarg.ext", # Automatic argparse command line argument documentation
16+
"sphinx.ext.todo"
1817
]
1918

2019
# The suffix(es) of source filenames.
@@ -52,6 +51,7 @@
5251
"home_breadcrumbs": False,
5352
}
5453

54+
html_context = {}
5555
ctx = Path(__file__).resolve().parent / 'context.json'
5656
if ctx.is_file():
5757
html_context.update(loads(ctx.open('r').read()))

0 commit comments

Comments
 (0)