Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add sphinx docs #26

Open
wants to merge 35 commits into
base: master
Choose a base branch
from
+720 −2
Open

Add sphinx docs #26

Changes from 1 commit
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
4887f29
docs: Adding Sphinx quickstart config.
mithro Feb 22, 2018
4ffd365
docs: Using breathe + exhale.
mithro Feb 22, 2018
0b38bb4
docs: Update submodules on rtd.
mithro Feb 22, 2018
2e1fe08
docs: Try setting the versions.
mithro Feb 22, 2018
f429a13
docs: Adding API documentation to index.rst
mithro Feb 22, 2018
37fd6fc
docs: Lots of additions.
mithro Feb 22, 2018
8a2290f
docs: More changes to included files.
mithro Feb 22, 2018
c57fdd7
docs: Adding missing gateware subproject.
mithro Mar 4, 2018
fae9e56
docs: Don't try and install package if no setup.py
mithro Oct 28, 2018
5ab3344
docs: Ignore the 'build' directory.
mithro Oct 28, 2018
6657532
doc: Mark apidoc target as phony.
mithro Oct 28, 2018
258215a
docs: Better comments.
mithro Oct 28, 2018
90b5d93
docs: Add migen.
mithro Oct 28, 2018
84b6303
doc: At the top level to PYTHONPATH.
mithro Oct 28, 2018
1c84091
doc: Adding ability to test environment.
mithro Oct 28, 2018
160a528
docs: Clone the wiki into the docs.
mithro Oct 28, 2018
1730842
docs: Cleanup the auto apidoc generation.
mithro Oct 28, 2018
3955344
docs: Rework third_party module finding.
mithro Oct 28, 2018
756de34
doc: Ignore wiki directory.
mithro Oct 28, 2018
a89cc5d
travis+docs: Enable a "docs" build on travis.
mithro Oct 28, 2018
9b4f11b
travis+docs: Make scripts executable.
mithro Oct 28, 2018
aadfbca
travis+docs: Improve the scripts.
mithro Oct 28, 2018
e9a23c5
docs: Clone wiki with https
mithro Oct 28, 2018
a986be7
doc: Force Makefile to use a shell of bash.
mithro Oct 28, 2018
faf085c
travis+docs: Install enchant deps.
mithro Oct 28, 2018
edf08b9
docs: Use harden_xml module.
mithro Oct 28, 2018
2fcc7bf
docs: Use sphinx-contrib-exhale-multiproject
mithro Oct 28, 2018
5b37b57
docs: Use sphinx-contrib-markdown-links.
mithro Oct 28, 2018
fdacd35
travis: Package not found.
mithro Oct 28, 2018
61a27ce
docs: Disable sphinxcontrib_trio
mithro Oct 28, 2018
f1b2de7
travis+docs: Add doxygen as requirement.
mithro Oct 28, 2018
a51357d
docs: Adding inv.py to downloads.
mithro Oct 28, 2018
b125860
docs: Improve index.
mithro Oct 28, 2018
40c0a71
docs: Autostructify?
mithro Oct 28, 2018
f73b327
Fix github_doc_root.
mithro May 8, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs: Add migen.
@mithro
mithro committed Oct 28, 2018
commit 90b5d9329cacb477381cbe5ebb94e11edad0f71d
4 changes: 2 additions & 2 deletions doc/Makefile
View file
Original file line number Diff line number Diff line change
@@ -98,19 +98,19 @@ inv: $(INTERSPHINX_FILES)

# Use sphinx-apidoc to auto-extract docstring
#--------------------------------------------

SPHINX_APIDOC = --follow-links --separate --module-first --append-syspath
apidoc:
rm -rf apidoc
sphinx-apidoc $(SPHINX_APIDOC) --implicit-namespaces -e -o apidoc/litex-buildenv ../ ../third_party ../doc ../build
sphinx-apidoc $(SPHINX_APIDOC) -o apidoc/third_party/litex ../third_party/litex/litex
sphinx-apidoc $(SPHINX_APIDOC) -o apidoc/third_party/litedram ../third_party/litedram/litedram
sphinx-apidoc $(SPHINX_APIDOC) -o apidoc/third_party/liteeth ../third_party/liteeth/liteeth
sphinx-apidoc $(SPHINX_APIDOC) -o apidoc/third_party/litepcie ../third_party/litepcie/litepcie
sphinx-apidoc $(SPHINX_APIDOC) -o apidoc/third_party/litesata ../third_party/litesata/litesata
sphinx-apidoc $(SPHINX_APIDOC) -o apidoc/third_party/litescope ../third_party/litescope/litescope
sphinx-apidoc $(SPHINX_APIDOC) -o apidoc/third_party/liteusb ../third_party/liteusb/liteusb
sphinx-apidoc $(SPHINX_APIDOC) -o apidoc/third_party/litevideo ../third_party/litevideo/litevideo
sphinx-apidoc $(SPHINX_APIDOC) -o apidoc/third_party/litex ../third_party/litex/litex
sphinx-apidoc $(SPHINX_APIDOC) -o apidoc/third_party/litex ../third_party/migen/migen

.PHONY: apidoc