Valentin Lorentz
40e1916510
Fix various Sphinx warnings
2021-04-13 21:56:08 +02:00
Valentin Lorentz
465506a0ce
Remove old lister tutorial.
...
Sphinx complains because it's an orphan document.
2021-04-13 18:31:31 +02:00
tenma
2e17729e97
docs: Add new "howto write a lister tutorial" with unified lister api
...
This adds a new tutorial which details how to currently write the new listers (both
incremental or stateless). This proposes a python template file to start a new lister.
At last, this renames the previous tutorial into tutorial-2017.
Related to T3073
2021-02-26 16:05:18 +01:00
David Douard
3ddfd00e90
Fix typos (and trailing ws) reported by codespell
2019-11-21 14:11:18 +01:00
Antoine R. Dumont (@ardumont)
481b30c540
docs: Fix toc
...
Related T1984
2019-09-06 12:31:06 +02:00
Antoine R. Dumont (@ardumont)
b3463ecddc
Drop SWH prefix in classes everywhere
...
It's redundant with the swh modules in itself.
2019-06-20 19:08:46 +02:00
Archit Agrawal
8d1b5d2d2d
Add new page "run_a new_lister"
...
Add new page in lister tutorial which guides
through the process of running a new lister in
docker.
2019-06-20 14:01:13 +05:30
Archit Agrawal
b2c6ddc35b
tutorial: Add testing and how to run section
...
Add testing section for lister. Also added how to run a
new lister section which elaborates about the steps
required to run the now lister in docker
2019-06-20 14:01:13 +05:30
David Douard
2fa3908283
docs: prevent sphinx from complaining about tutorial.rst not being included
2018-11-09 11:21:08 +01:00
Antoine R. Dumont (@ardumont)
d9a25865a2
docs/tutorials: Format sentences
2018-06-26 10:48:12 +02:00
Antoine R. Dumont (@ardumont)
4b351321d8
docs/tutorials: Remove blank spaces
2018-06-26 10:48:03 +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