From ce154cf55b742600ec2e4c04c4d3d70bf702a411 Mon Sep 17 00:00:00 2001 From: Nick Sweeting Date: Tue, 30 Apr 2019 23:15:03 -0400 Subject: [PATCH] add new modules and usage example --- Usage.md | 9 +++++---- archivebox.index.rst | 8 ++++++++ archivebox.rst | 8 ++++++++ 3 files changed, 21 insertions(+), 4 deletions(-) diff --git a/Usage.md b/Usage.md index 70a59c9..daaa601 100644 --- a/Usage.md +++ b/Usage.md @@ -169,10 +169,11 @@ which are already in the index. ```python from archivebox.main import add, info, remove, check_data_folder -check_data_folder() -add('https://example.com', index_only=True) -info() -remove('https://example.com', delete=True, yes=True) +out_dir = '~/path/to/my/data/folder' +check_data_folder(out_dir=out_dir) +add('https://example.com', index_only=True, out_dir=out_dir) +info(out_dir=out_dir) +remove('https://example.com', delete=True, yes=True, out_dir=out_dir) ``` For more information see the Python API Reference. diff --git a/archivebox.index.rst b/archivebox.index.rst index 58989cd..49ab62c 100644 --- a/archivebox.index.rst +++ b/archivebox.index.rst @@ -4,6 +4,14 @@ archivebox.index package Submodules ---------- +archivebox.index.csv module +--------------------------- + +.. automodule:: archivebox.index.csv + :members: + :undoc-members: + :show-inheritance: + archivebox.index.html module ---------------------------- diff --git a/archivebox.rst b/archivebox.rst index d9360ac..b96e694 100644 --- a/archivebox.rst +++ b/archivebox.rst @@ -32,6 +32,14 @@ archivebox.manage module :undoc-members: :show-inheritance: +archivebox.system module +------------------------ + +.. automodule:: archivebox.system + :members: + :undoc-members: + :show-inheritance: + archivebox.util module ----------------------