1
0
mirror of https://github.com/pirate/ArchiveBox.git synced 2025-08-23 22:53:00 +02:00

add new modules and usage example

Nick Sweeting
2019-04-30 23:15:03 -04:00
parent c243cd2795
commit ce154cf55b
3 changed files with 21 additions and 4 deletions

@@ -169,10 +169,11 @@ which are already in the index.
```python ```python
from archivebox.main import add, info, remove, check_data_folder from archivebox.main import add, info, remove, check_data_folder
check_data_folder() out_dir = '~/path/to/my/data/folder'
add('https://example.com', index_only=True) check_data_folder(out_dir=out_dir)
info() add('https://example.com', index_only=True, out_dir=out_dir)
remove('https://example.com', delete=True, yes=True) 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. For more information see the Python API Reference.

@@ -4,6 +4,14 @@ archivebox.index package
Submodules Submodules
---------- ----------
archivebox.index.csv module
---------------------------
.. automodule:: archivebox.index.csv
:members:
:undoc-members:
:show-inheritance:
archivebox.index.html module archivebox.index.html module
---------------------------- ----------------------------

@@ -32,6 +32,14 @@ archivebox.manage module
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
archivebox.system module
------------------------
.. automodule:: archivebox.system
:members:
:undoc-members:
:show-inheritance:
archivebox.util module archivebox.util module
---------------------- ----------------------