Patrick Robertson
d10c7fbe55
Better documentation based on the discord feedbackgst
2025-02-24 22:42:57 +00:00
Patrick Robertson
091a19e25c
Further docs improvements/tidy ups
2025-02-21 16:52:30 +00:00
Patrick Robertson
77212e8e3f
Finishing touches to the how-tos
2025-02-20 15:45:48 +00:00
Patrick Robertson
0bec71d203
Finish how to on authentication
2025-02-20 15:33:50 +00:00
Patrick Robertson
eda359a1ef
Fix json loader - it should go in 'validators' not 'utils'
...
Fixes #214
2025-02-20 13:10:39 +00:00
Patrick Robertson
40488e0869
Use 'Auto Archiver' naming for consistency.
...
auto-archiver is reserved in the docs for when talking about the command line usage
2025-02-20 11:50:29 +00:00
Patrick Robertson
061f29c885
How-to on updating config file to version 0.13+
2025-02-20 11:46:57 +00:00
Patrick Robertson
7dde8d609d
Merge main
2025-02-20 10:29:57 +00:00
Patrick Robertson
6ea943b680
Fix link
2025-02-20 10:27:24 +00:00
Patrick Robertson
a9802dd004
Remove the global _LAZY_LOADED_MODULES and allow each instance of ArchivingOrchestrator to load its own modules
2025-02-19 12:25:35 +00:00
Patrick Robertson
222a94563f
WIP: Docs tidyups+add howto on logging and authentication
...
(Authentication is WIP)
2025-02-19 10:37:04 +00:00
Patrick Robertson
3c543a3a6a
Various fixes for issues with new architecture ( #208 )
...
* Add formatters to the TOC - fixes #204
* Add 'steps' settings to the example YAML in the docs. Fixes #206
* Improved docs on authentication architecture
* Fix setting modules on the command line - they now override any module settings in the orchestration as opposed to appending
* Fix tests for gsheet-feeder: add a test service_account.json (note: not real keys in there)
* Rename the command line entrypoint to _command_line_run
Also: make it clear that code implementation should not call this
Make sure the command line entry returns (we don't want a generator)
* Fix unit tests to use now code-entry points
* Version bump
* Move iterating of generator up to __main__
* Breakpoint
* two minor fixes
* Fix unit tests + add new '__main__' entry point implementation test
* Skip youtube tests if running on CI. Should still run them locally
* Fix full implementation run on GH actions
* Fix skipif test for GH Actions CI
* Add skipifs for truth - it blocks GH:
---------
Co-authored-by: msramalho <19508417+msramalho@users.noreply.github.com>
2025-02-18 19:10:09 +00:00
erinhmclark
da267f20d7
Update screenshot refs
2025-02-12 11:54:40 +00:00
Patrick Robertson
86254bdd4e
Fix link in how to
2025-02-12 11:48:01 +00:00
Patrick Robertson
17f13db56c
Make that code block a shell
2025-02-12 11:45:09 +00:00
Patrick Robertson
8054ea96b3
Document double dash between command line args and feeder urls on command line
2025-02-12 11:20:15 +00:00
Patrick Robertson
de79e17128
better wording in link
2025-02-12 11:19:21 +00:00
Patrick Robertson
d28d99daa6
Docs tidy ups and re-organising
2025-02-12 11:16:17 +00:00
Patrick Robertson
d8f47ff9e4
Add multi-type modules to all headings on TOC
2025-02-11 19:46:57 +00:00
Patrick Robertson
1ee7981c6e
Add YAML config to the module docs
2025-02-11 19:42:03 +00:00
Patrick Robertson
22fa9ba456
further tweaks
2025-02-11 18:52:28 +00:00
Patrick Robertson
2c87474186
Change path for scripts
2025-02-11 18:37:03 +00:00
Patrick Robertson
e65a99078f
Slight tweaks of toctrees + reordering
2025-02-11 18:28:21 +00:00
Patrick Robertson
62154ddfef
Further tweaks and fixes
2025-02-11 14:37:29 +00:00
Patrick Robertson
895c843f04
Add a cheat sheet for configs and better folder structure for core modules
2025-02-11 14:06:53 +00:00
Patrick Robertson
2f51d3917a
Further addition to docs: creating modules, configurations, installation
2025-02-11 13:49:30 +00:00
Patrick Robertson
dbc564e18b
Add sphinx_book_theme theme to poetry
2025-02-10 22:58:52 +00:00
Patrick Robertson
2650cd8fb2
Use a script to auto-generate documentation for the core modules from the manifest file
2025-02-10 22:51:04 +00:00
Patrick Robertson
824728739a
Start fleshing out the docs more - rearrange, separate out modules section, move files over to md (from rst)
2025-02-10 16:24:16 +00:00
erinhmclark
e83ccc0d7f
Cleaning up configs reference and module level.
2025-01-21 09:48:46 +00:00
erinhmclark
170f8d18a6
Add instructions to README.md, include build directories in .gitignore and do a bit more tidying,
2025-01-16 20:46:10 +00:00
erinhmclark
a6aacfa3fb
Add example pre-generated configs.rst
2025-01-16 09:31:50 +00:00
erinhmclark
d3eec5d90f
Basic docs structure for RTD
2025-01-15 21:45:29 +00:00
Logan Williams
f2e580de4e
Update README images
2023-05-11 14:30:27 +02:00
Logan Williams
a65b0eb6e9
Merge branch 'main' of github.com:bellingcat/auto-archiver
2021-06-01 11:00:52 +02:00
Logan Williams
aaf75eb284
Add internet archive fallback
2021-06-01 11:00:40 +02:00
Logan Williams
4e21603407
Add documentation for auto-auto-archiver
2021-05-14 14:07:16 +02:00
Logan Williams
339f62fade
Update auto archiver docs with new header declaration method
2021-05-12 09:01:45 +02:00
Logan Williams
0d1dc42654
Add readme
2021-02-09 15:19:46 +01:00