Add a cheat sheet for configs and better folder structure for core modules

This commit is contained in:
Patrick Robertson
2025-02-11 14:06:53 +00:00
parent 2f51d3917a
commit 895c843f04
10 changed files with 56 additions and 8 deletions

View File

@@ -18,6 +18,7 @@ These pages describe the core modules that come with `auto-archiver` and provide
:caption: Core Modules
:hidden:
modules/config_cheatsheet
modules/feeder
modules/extractor
modules/enricher

View File

@@ -0,0 +1,6 @@
# Configuration Cheat Sheet
Below is a list of all configurations for the core modules in Auto Archiver
```{include} ../modules/autogen/configs_cheatsheet.md
```

View File

@@ -1,5 +1,5 @@
# Configuring
# Configuration
```{toctree}

View File

@@ -4,6 +4,7 @@
:depth: 1
configurations.md
config_cheatsheet.md
```
There are 3 main ways to use the auto-archiver:

View File

@@ -6,3 +6,9 @@ The default (enabled) databases are the CSV Database and the Console Database.
```{include} autogen/database.md
```
```{toctree}
:depth: 1
:glob:
autogen/database/*
```

View File

@@ -4,4 +4,10 @@ Enricher modules are used to add additional information to the items that have
```{include} autogen/enricher.md
```
```{toctree}
:depth: 1
:glob:
autogen/enricher/*
```

View File

@@ -8,4 +8,10 @@ Extractors that are able to extract content from a wide range of websites includ
3. WACZ Extractor: runs a web browser to 'browse' the URL and save a copy of the page in WACZ format.
```{include} autogen/extractor.md
```
```{toctree}
:depth: 1
:glob:
autogen/extractor/*
```

View File

@@ -5,4 +5,10 @@ Feeder modules are used to feed URLs into the `auto-archiver` for processing. Fe
The default feeder is the command line feeder, which allows you to input URLs directly into the `auto-archiver` from the command line.
```{include} autogen/feeder.md
```
```{toctree}
:depth: 1
:glob:
autogen/feeder/*
```

View File

@@ -3,4 +3,10 @@
Formatter modules are used to format the data extracted from a URL into a specific format. Currently the most widely-used formatter is the HTML formatter, which formats the data into an easily viewable HTML page.
```{include} autogen/formatter.md
```
```{toctree}
:depth: 1
:glob:
autogen/formatter/*
```