Skip to content

Commit f1ea1b7

Browse files
authored
Merge pull request #288 from eric-wieser/docs-use-rst
Use an rst file for galgebra_guide instead of a notebook.
2 parents 1abbc18 + 9d62a19 commit f1ea1b7

File tree

6 files changed

+2197
-4118
lines changed

6 files changed

+2197
-4118
lines changed

doc/Makefile

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,5 +26,4 @@ help:
2626
# Catch-all target: route all unknown targets to Sphinx using the new
2727
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
2828
%: Makefile
29-
notedown galgebra.md > galgebra_guide.ipynb
3029
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

doc/README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,9 @@ The structure of the `doc` diretory is:
1212
#
1313
├─ index.rst # The entry point of the Sphinx doc, it references both
1414
# galgebra_guide.ipynb and api.rst
15-
├─ galgebra.tex # The orignal LaTeX source that generated books/galgebra.pdf
16-
├─ galgebra.md # The Markdown source semi-auto converted from galgebra.tex
17-
# please edit this instead of galgebra.tex (deprecated by it)
18-
# or galgebra_guide.ipynb (auto generated from it)
19-
├─ galgebra_guide.ipynb # The Jupyter notebook converted from galgebra.md
15+
├─ galgebra.tex # The original LaTeX source that generated books/galgebra.pdf
16+
├─ galgebra_guide.rst # The convert vertion of the latex document.
17+
# This was converted to markdown manually, then to rST via nodedown and nbsphinx.
2018
├─ api.rst # Use automodule to extract doc from galgebra Python source files
2119
2220
# Configurations:

0 commit comments

Comments
 (0)