From e65a99078f78a0e7d9ff956ce44fe72feb7e1764 Mon Sep 17 00:00:00 2001 From: Patrick Robertson Date: Tue, 11 Feb 2025 18:28:21 +0000 Subject: [PATCH] Slight tweaks of toctrees + reordering --- docs/source/index.md | 2 +- docs/source/installation/configurations.md | 7 ------- docs/source/installation/installation.md | 1 + docs/source/modules/feeder.md | 7 ++++++- 4 files changed, 8 insertions(+), 9 deletions(-) diff --git a/docs/source/index.md b/docs/source/index.md index bcab52a..57e8d60 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -8,9 +8,9 @@ :caption: Contents: Overview -how_to installation/installation.rst core_modules.md +how_to development/developer_guidelines autoapi/index.rst ``` \ No newline at end of file diff --git a/docs/source/installation/configurations.md b/docs/source/installation/configurations.md index 6dab1ab..b83a064 100644 --- a/docs/source/installation/configurations.md +++ b/docs/source/installation/configurations.md @@ -1,13 +1,6 @@ # Configuration - -```{toctree} -:hidden: - -configurations -``` - This section of the documentation provides guidelines for configuring the tool. ## Configuring from the Command Line diff --git a/docs/source/installation/installation.md b/docs/source/installation/installation.md index 8abff21..337a392 100644 --- a/docs/source/installation/installation.md +++ b/docs/source/installation/installation.md @@ -2,6 +2,7 @@ ```{toctree} :depth: 1 +:hidden: configurations.md config_cheatsheet.md diff --git a/docs/source/modules/feeder.md b/docs/source/modules/feeder.md index 9b6c403..be51aa8 100644 --- a/docs/source/modules/feeder.md +++ b/docs/source/modules/feeder.md @@ -2,7 +2,12 @@ Feeder modules are used to feed URLs into the `auto-archiver` for processing. Feeders can take these URLs from a variety of sources, such as a file, a database, or the command line. -The default feeder is the command line feeder, which allows you to input URLs directly into the `auto-archiver` from the command line. +The default feeder is the command line feeder (`cli_feeder`), which allows you to input URLs directly into the `auto-archiver` from the command line. + +Command line feeder usage: +```{code} bash +auto-archiver [options] URL1 URL2 ... +``` ```{include} autogen/feeder.md ```