Skip to content

Commit

Permalink
Refactored documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
coordt committed Dec 12, 2021
1 parent 1d7654e commit 8c0c4eb
Show file tree
Hide file tree
Showing 88 changed files with 256 additions and 8,442 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,10 @@ output/*/index.html
junit-*.xml
flake8-errors.txt

# Documentation building
_build
doc_src/api/categories*.rst

RELEASE.txt
site-packages
reports
Expand Down
7 changes: 7 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -83,3 +83,10 @@ release-patch: set-release-patch-env-var release-helper ## Release a new patch
release-minor: set-release-minor-env-var release-helper ## Release a new minor version: 1.1.1 -> 1.2.0

release-major: set-release-major-env-var release-helper ## release a new major version: 1.1.1 -> 2.0.0

documentation:
mkdir -p docs
rm -f doc_src/api/$(SOURCE_DIR)*.rst
ls -A1 docs | xargs -I {} rm -rf docs/{}
$(MAKE) -C doc_src clean html
cp -a doc_src/_build/html/. docs
6 changes: 3 additions & 3 deletions doc_src/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ SPHINXOPTS = -a
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
DESTDIR = ..
DESTDIR = _build

# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
Expand All @@ -32,9 +32,9 @@ clean:
-rm -rf $(BUILDDIR)/*

html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(DESTDIR)/docs
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(DESTDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(DESTDIR)/docs."
@echo "Build finished. The HTML pages are in $(DESTDIR)/html."

dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
Expand Down
Binary file removed doc_src/_static/breadcrumb_background.png
Binary file not shown.
32 changes: 32 additions & 0 deletions doc_src/_static/css/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
.sig-prename.descclassname {
display: none;
}
dl.attribute {
margin-bottom: 30px;
}
dl.field-list {
display: block;
}
dl.field-list > dt {
padding-left: 0;
}
dl.field-list > dd {
padding-left: 1em;
border-left: 0;
}
dl.field-list > dd > ul.simple {
list-style-type: none;
padding-left: 0;
}
dl.field-list > dd + dt {
margin-top: 0.5em;
}
dd {
margin-left: 0;
padding-left: 30px;
border-left: 1px solid #c9c9c9;
}
.table.autosummary td {
border-top: 0;
border-bottom: 1px solid #dee2e6;
}

0 comments on commit 8c0c4eb

Please sign in to comment.