bellingcat/cisticola
1
0
Fork 0
mirror of https://github.com/bellingcat/cisticola.git synced 2026-06-11 04:48:33 +03:00
Code Issues Packages Projects Releases Wiki Activity

added and made more consistent docstrings, wrote script that makes minor edits to Sphinx apidocs to improve documentation clarity

Browse Source
This commit is contained in:
Tristan Lee
2023-08-03 17:27:33 -05:00
parent b8ddc400f3
commit edd772eb94
7 changed files with 183 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/source/about.rst
View File

@@ -20,4 +20,9 @@ Cisticola has many components
The data extracted by scrapers varies by platform, but typically includes media files attached to posts.
Separating the "scraping" and "transforming" steps is useful because it ensures that no data is thrown away during the transormation. There may be some fields in the raw data that aren't included in the transformed format, but could be found to be useful in the future.
Separating the "scraping" and "transforming" steps is useful because it ensures that no data is thrown away during the transormation. There may be some fields in the raw data that aren't included in the transformed format, but could be found to be useful in the future.
TODO
- Add diagram
- Describe common workflow and steps
- Update environment variables

4
docs/source/cisticola.rst
View File

@@ -10,7 +10,7 @@ Subpackages
-----------
.. toctree::
:maxdepth: 4
:maxdepth: 1
cisticola.scraper
cisticola.transformer
@@ -19,7 +19,7 @@ Submodules
----------
.. toctree::
:maxdepth: 4
:maxdepth: 1
cisticola.base
cisticola.utils