Commit Graph

11 Commits

Author SHA1 Message Date
Jan Kundrát
f56e64410b docs: brand the generated docs with our shiny logo
Image source: I took the existing banner, cropped it and resized to
200px width as per the theme docs.

Change-Id: Ic79b6164d557298746fe878de31ee0a9b0d93923
2020-05-19 18:11:29 +02:00
Jan Kundrát
5a1e3f30b3 docs: Fix all sphinx warnings
...and also enforce a warning-free build within the CI.

Change-Id: Ia406a0a1ca2e89ceaa0288ae82128fa9427fe066
2020-03-27 15:07:19 +01:00
Jan Kundrát
c675f5bd38 docs: do not reference a non-existing directory
Change-Id: I197956d3b55f0ebcf20cee54d5f2887bbd821fa3
2020-03-25 19:34:42 +01:00
Jan Kundrát
4d5d10935a Convert to pbr setup
It turns out that our current setup does not really support the `sdist`
Python packaging step. I'm trying to increase automation, both for
making releases for upload to pypi.org, and also for CI via Zuul. As it
turns out, Zuul comes with a set of predefined jobs which -- by default
-- use `tox`, and tox was having troubles dealing with our `setup.py`
because it also assumes that the `sdist` step works. It is also supposed
to:

- fix version number duplication in `setup.py`,
- fix version number duplication in Sphinx docs,
- prevent the need to write a `MANIFEST.in` manually.

TL;DR: insetad of having to deal with a ton of other creative
boilerplate, use tools for lazy people like me, and PBR ("Python Build
Reasonableness") appears to check the marks here.

Change-Id: I27c36c4f6b0e76857d16f7819ec237e9b811476a
2020-03-25 19:34:42 +01:00
Jan Kundrát
f46134fda5 docs: document the _private methods
This is a reference documentation, so it makes sense for it to be
reasonably complete.
2019-06-06 23:05:42 +02:00
Jan Kundrát
bfecff0412 docs: use a default preset here to prevent extra repetitions 2019-06-06 23:04:34 +02:00
James Powell
a3273d24b5 doc fixes 2018-03-15 14:46:24 -04:00
Mattia Cantono
ba06a0e104 Add NLI Evaluation in Fiber class (#33)
* Add Travis-CI configuration for continous integration
* Add GN-Model Documentation and auto-doc integration
* Add GN model to Fiber
* Unit of measure conversion adapted to SI
2018-02-28 11:53:58 -05:00
Mattia Cantono
3fae7210d8 Add Sphinx Documentation and ReadTheDocs integration (#18)
* Add sphinx documentation for readthedocs integration
* Edit README
* Edit README
* Update README formatting
* Update HTML template in conf.py
* Add .travis.yml
2018-01-10 19:50:18 -05:00
James Powell
c8ce640a2a start fresh 2017-10-31 19:39:10 -04:00
Gilad Goldfarb
b0f2ad23a6 initial commit 2017-07-11 10:00:44 -07:00