Skip to content

Commit 38cc954

Browse files
committed
update docs builder to use myst-parser and autodoc2
1 parent a39e98c commit 38cc954

File tree

215 files changed

+32384
-1740
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

215 files changed

+32384
-1740
lines changed

Contents.rst

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
1-
Intro
2-
#####
1+
Contents
2+
########
3+
4+
Overview
5+
########
36

47
.. toctree::
58
:maxdepth: 1
@@ -11,49 +14,46 @@ Getting Started
1114
###############
1215

1316
.. toctree::
14-
:maxdepth: 2
17+
:maxdepth: 1
1518

1619
Quickstart.md
1720
Install.md
1821
Docker.md
19-
20-
21-
General
22-
#######
22+
Configuration.md
23+
Security-Overview.md
2324

2425
.. toctree::
2526
:maxdepth: 2
2627

2728
Usage.md
28-
Configuration.md
29-
Troubleshooting.md
30-
Security-Overview.md
29+
30+
Guides
31+
######
32+
33+
.. toctree::
34+
:maxdepth: 1
35+
36+
Setting-Up-Storage.md
37+
Setting-up-Authentication.md
38+
Setting-up-Search.md
3139
Publishing-Your-Archive.md
3240
Scheduled-Archiving.md
3341
Chromium-Install.md
34-
Upgrading-or-Merging-Archives.md
42+
Upgrading.md
43+
Merging-Collections.md
44+
Troubleshooting.md
3545

3646

3747
API Reference
3848
#############
3949

4050
.. toctree::
41-
:maxdepth: 1
42-
43-
Configuration Options <Configuration.md>
44-
Data Folder Layout <Usage.md>
45-
Command Line Interface <Usage.md>
46-
Web Interface <Usage.md>
47-
Python API <modules>
48-
REST API <modules>
49-
50-
.. - [Configuration Options](Configuration.md)
51-
.. - [Data Folder Layout](Configuration.md)
52-
.. - [Command Line Interface](Usage.md)
53-
.. - [Web Interface](Usage.md)
54-
.. - [Python API](modules)
55-
.. - REST API (Coming soon...)
51+
:maxdepth: 3
5652

53+
Filesystem <https://github.com/ArchiveBox/ArchiveBox/wiki/Usage#disk-layout>
54+
SQL API <https://github.com/ArchiveBox/ArchiveBox/wiki/Usage#sql-shell-usage>
55+
REST API <https://demo.archivebox.io/api>
56+
Python API <apidocs/index>
5757

5858
Meta
5959
####

Merging-Collections.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Merging two or more existing archives
1+
# Merging Collections
22

33
Two or more existing ArchiveBox collection dirs can be merged together by simply combining the contents of `archive/*` and re-running `archivebox init` to pull the new Snapshots into the index.
44

@@ -121,4 +121,4 @@ See here [Troubleshooting: Database](https://github.com/ArchiveBox/ArchiveBox/wi
121121
- https://github.com/ArchiveBox/ArchiveBox/wiki/Usage#large-archives
122122
- https://github.com/ArchiveBox/ArchiveBox/wiki/Security-Overview#output-folder
123123
- https://github.com/ArchiveBox/ArchiveBox/wiki/Usage#python-shell-usage
124-
- https://github.com/ArchiveBox/ArchiveBox/wiki/Usage#sql-shell-usage
124+
- https://github.com/ArchiveBox/ArchiveBox/wiki/Usage#sql-shell-usage

Security-Overview.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# Security Overview
2+
13
> *💬 We offer [consulting services](https://docs.monadical.com/s/archivebox-consulting-services) to set up, secure, and maintain ArchiveBox on your preferred hosting environment.*
24
> <sub>We use this revenue (from corporate clients who can afford to pay) to support open source development and keep ArchiveBox free.</sub>
35

Setting-Up-Storage.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# Setting Up Storage
2+
13
> *💬 We offer [consulting services](https://docs.monadical.com/s/archivebox-consulting-services) to set up, secure, and maintain ArchiveBox on your preferred storage provider.*
24
> <sub>We use this revenue (from corporate clients who can afford to pay) to support open source development and keep ArchiveBox free.</sub>
35
@@ -296,4 +298,4 @@ docker compose run archivebox /bin/bash 'ls -lah /data/archive/ | tee /data/arch
296298

297299
- [IPFS](https://github.com/djdv/go-filesystem-utils/pull/40) / [Peergos](https://github.com/peergos/peergos) / [GlusterFS](https://github.com/calavera/docker-volume-glusterfs)
298300
- [DigitalOcean Block Storage Volumes](https://github.com/djmaze/dobs-volume-plugin) / [Linode Block Storage Volumes](https://github.com/linode/docker-volume-linode)
299-
- [More volume plugins...](https://docs.docker.com/engine/extend/legacy_plugins/#volume-plugins)
301+
- [More volume plugins...](https://docs.docker.com/engine/extend/legacy_plugins/#volume-plugins)

Setting-up-Authentication.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# Setting Up Authentication
2+
13
> *💬 We offer [consulting services](https://docs.monadical.com/s/archivebox-consulting-services) to set up, integrate, and maintain ArchiveBox with your org's auth & hosting.
24
> If you need support, advanced development to capture difficult sites, audit logging, and more, we can provide it!*
35
> <sub>We use this revenue (from corporate clients who can afford to pay) to support open source development and keep ArchiveBox free.</sub>
@@ -240,4 +242,4 @@ curl -X 'GET' \
240242

241243
- The ArchiveBox API auth implementation: [`archivebox/api/auth.py`](https://github.com/ArchiveBox/ArchiveBox/blob/dev/archivebox/api/auth.py#:~:text=API_AUTH_METHODS) + [`archivebox/api/v1_auth.py`](https://github.com/ArchiveBox/ArchiveBox/blob/dev/archivebox/api/v1_auth.py)
242244
- The [`django-ninja` auth documentation](https://django-ninja.dev/guides/authentication/) (which powers our API)
243-
- The [Swagger auth documentation](https://swagger.io/docs/specification/authentication/) for the interactive API Docs UI
245+
- The [Swagger auth documentation](https://swagger.io/docs/specification/authentication/) for the interactive API Docs UI

Setting-up-Search.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# Setting Up Search
2+
13
## How to Search in ArchiveBox
24

35
You can search your ArchiveBox data in a number of ways:
@@ -253,4 +255,4 @@ archivebox config --set FTS_SQLITE_MAX_LENGTH=1000000000
253255
* [#1320 Troubleshooting: Sonic backend Error: ENDED authentication_failed doesn't contain protocol(NUMBER)](https://github.com/ArchiveBox/ArchiveBox/pull/1320)
254256

255257
- [#1139 Feature Request: Add AI-assisted summarization, tagging, search, and more using LLMs / RAG](https://github.com/ArchiveBox/ArchiveBox/issues/1139)
256-
- [#1358 Django Admin general improvements: tree view, better filters, better sorting, custom pages, etc.](https://github.com/ArchiveBox/ArchiveBox/issues/1358)
258+
- [#1358 Django Admin general improvements: tree view, better filters, better sorting, custom pages, etc.](https://github.com/ArchiveBox/ArchiveBox/issues/1358)

Upgrading.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Upgrade your ArchiveBox collection to a new version
1+
# Upgrading Versions
22

33
```bash
44
# cd /path/to/your/archivebox/data
@@ -127,15 +127,15 @@ More info:
127127
- https://aur.archlinux.org/packages/archivebox
128128
- https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/misc/archivebox/default.nix
129129

130-
---
130+
<hr/>
131131

132132
## Merge two or more existing archives
133133

134134
See [[Merging Collections]]...
135135

136136
<br/>
137137

138-
---
138+
<hr/>
139139

140140
## Related Documents
141141

@@ -144,4 +144,4 @@ See [[Merging Collections]]...
144144
- https://github.com/ArchiveBox/ArchiveBox/wiki/Usage#large-archives
145145
- https://github.com/ArchiveBox/ArchiveBox/wiki/Security-Overview#output-folder
146146
- https://github.com/ArchiveBox/ArchiveBox/wiki/Usage#python-shell-usage
147-
- https://github.com/ArchiveBox/ArchiveBox/wiki/Usage#sql-shell-usage
147+
- https://github.com/ArchiveBox/ArchiveBox/wiki/Usage#sql-shell-usage
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# {py:mod}`archivebox.__main__`
2+
3+
```{py:module} archivebox.__main__
4+
```
5+
6+
```{autodoc2-docstring} archivebox.__main__
7+
:allowtitles:
8+
```
9+
10+
## Module Contents
11+
12+
### Data
13+
14+
````{list-table}
15+
:class: autosummary longtable
16+
:align: left
17+
18+
* - {py:obj}`__package__ <archivebox.__main__.__package__>`
19+
- ```{autodoc2-docstring} archivebox.__main__.__package__
20+
:summary:
21+
```
22+
* - {py:obj}`ASCII_LOGO_MINI <archivebox.__main__.ASCII_LOGO_MINI>`
23+
- ```{autodoc2-docstring} archivebox.__main__.ASCII_LOGO_MINI
24+
:summary:
25+
```
26+
````
27+
28+
### API
29+
30+
````{py:data} __package__
31+
:canonical: archivebox.__main__.__package__
32+
:value: >
33+
'archivebox'
34+
35+
```{autodoc2-docstring} archivebox.__main__.__package__
36+
```
37+
38+
````
39+
40+
````{py:data} ASCII_LOGO_MINI
41+
:canonical: archivebox.__main__.ASCII_LOGO_MINI
42+
:value: <Multiline-String>
43+
44+
```{autodoc2-docstring} archivebox.__main__.ASCII_LOGO_MINI
45+
```
46+
47+
````

0 commit comments

Comments
 (0)