Antoine Lambert
4cec345028
docs: Include module indices only when building standalone package doc
...
In order to remove warnings about /apidoc/*.rst files being included
multiple times in toc when building full swh documentation, prefer to
include module indices only when building standalone package documentation.
Also include them the proper sphinx way.
Related to T4496
2022-12-19 13:46:51 +01:00
Antoine R. Dumont (@ardumont)
1a9c08c93f
docs: Add a save forge documentation
...
This does not yet enter into the registration of a new lister.
Related to T3629
2021-10-08 16:07:40 +02:00
David Douard
b1811f9f8a
Add a cli section to the doc
2021-01-05 11:53:22 +01:00
Antoine Lambert
99fcd2b3f5
docs: Fix sphinx warnings
...
Related to T2188
2020-01-17 16:15:11 +01:00
Antoine R. Dumont (@ardumont)
481b30c540
docs: Fix toc
...
Related T1984
2019-09-06 12:31:06 +02:00
David Douard
da4eb6cd34
doc: update index to match new swh-doc format
...
related to T1330
2018-11-23 13:50:51 +01:00
Stefano Zacchiroli
3d65b9f223
docs: add title and brief module description
2018-10-01 15:53:13 +02:00
Stefano Zacchiroli
b8ad57fc05
docs: integrate swh-lister tutorial
...
originally appeared on the Software Heritage blog at
https://www.softwareheritage.org/2017/03/24/list-the-content-of-your-favorite-forge-in-just-a-few-steps/
by Avi Kelman
Closes T762
2017-11-02 17:53:30 +01:00
Stefano Zacchiroli
fe4725d383
docs: add absolute anchor to documentation index
2017-11-02 11:09:07 +01:00
Stefano Zacchiroli
67a4c62a64
docs/: add sphinx apidoc generation skeleton
...
change cherry picked from python module template
commit 71b117ba0cf9f1251b1cac26d0994df03a4c787d
2017-08-30 12:25:37 +02:00