Nick Sweeting
14751a4942
Sync documentation from ArchiveBox dev
2026-09-01 12:03:28 -07:00
Nick Sweeting
5937a62bda
docs: fix stale config refs across wiki pages + minor typo fixes
...
Sweep of all prose doc pages to fix references that were stale, wrong,
or pointed at anchors/options that no longer exist in 0.9.x.
Critical (non-functional examples + factual errors):
- All `PUBLIC_SNAPSHOTS=...` examples (Security-Overview, Publishing-
Your-Archive, Usage) replaced with `PERMISSIONS=public|private`.
- Setting-up-Authentication: drop the "edit CSRF_TRUSTED_ORIGINS in
archivebox/core/settings.py source" advice (no longer user-settable);
update auth-permissions list to use PERMISSIONS instead of
PUBLIC_SNAPSHOTS.
- Security-Overview: SAVE_ARCHIVE_DOT_ORG (with extra underscores)
was never real; use ARCHIVEDOTORG_ENABLED.
- Docker/Install/Usage: FETCH_TITLE/FETCH_SCREENSHOT/FETCH_PDF/FETCH_DOM
were never aliases (only FETCH_MEDIA is); replace with real
<PLUGIN>_ENABLED.
- Troubleshooting: CHROME_BINARY default is `chromium`, not
`chromium-browser`. Also fixed deprecated `brew cask upgrade
chromium-browser` -> `brew upgrade --cask chromium`.
- Docker: typo MAX_MEDIA_SIZE -> MEDIA_MAX_SIZE.
Broken Configuration anchors (must be lowercase on GitHub wiki):
- Security-Overview: #FOOTER_INFO / #OUTPUT_PERMISSIONS / #COOKIES_FILE
-> lowercase.
- Setting-up-Authentication: combined #public_index--public_snapshots--public_add_view
-> individual #public_index / #public_add_view / #permissions.
Plugin option references now link to abx-plugins:
- CHROME_USER_DATA_DIR / CHROME_BINARY / CHROME_SANDBOX -> /#chrome
- RIPGREP_BINARY -> /#search_backend_ripgrep
- WGET_ENABLED / DOM_ENABLED / SAVE_WGET / SAVE_DOM -> respective anchors
- ARCHIVEDOTORG_ENABLED -> /#archivedotorg
- FAVICON_PROVIDER / FAVICON_ENABLED -> /#favicon
- MEDIA_ENABLED -> /#media
Legacy aliases:
- Scheduled-Archiving: URL_WHITELIST/URL_BLACKLIST -> URL_ALLOWLIST/
URL_DENYLIST; dropped non-existent `--overwrite` schedule flag.
Dead source links removed:
- Usage: archivebox/main.py + archivebox/config.py (split to cli/ and
config/common.py).
- Security-Overview: archivebox/extractors/*.py -> plugin anchors.
- Install: dead Configuration#dependency-options and
Configuration#archive-method-toggles anchors -> abx-plugins reference.
Typo fixes (codespell):
- preferrably -> preferably, necesary -> necessary, Rasberry ->
Raspberry, sytem -> system, Dissallow -> Disallow, whats -> what's,
filesytem -> filesystem.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-31 03:29:27 -07:00
Nick Sweeting
a85779b9a2
Add dev docs warning banner and RTD version strategy
...
RTD version setup:
- "stable" = default version users land on (latest non-prerelease tag)
- "latest" = dev docs from master branch (hidden, accessible by URL)
- Tags like v0.9.10 auto-build as versioned releases
Features:
- Dev warning banner shown on /en/latest/ pages via template override
- conf.py detects dev builds from version string or READTHEDOCS_VERSION
- Version switcher enabled in sphinx-rtd-theme
- Document RTD admin settings needed in .readthedocs.yaml comments
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-15 18:36:48 -07:00
Nick Sweeting
a3ba654513
Rebuild docs for new ArchiveBox v0.9.x architecture
...
- Remove stale abx_plugin/abx_spec apidocs (plugins moved to separate repo)
- Remove stale archivebox.rst referencing deleted modules (extractors, parsers, index, queues, seeds, etc.)
- Regenerate autodoc2 API docs matching current dev branch module layout
- Update Contents.rst toctree to include all wiki pages
- Update conf.py: remove vendor pkg scanning, add mermaid support, suppress harmless warnings
- Fix markdown titles in Home.md and Upgrading-or-Merging-Archives.md
- Fix Upgrading.md adjacent transitions and Scheduled-Archiving.md code block lexer
- Update bin/build_docs.sh to fetch from both remotes
- Add sphinxcontrib-mermaid to requirements.txt
- Merge latest changes from both wiki and docs remotes
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-15 15:54:33 -07:00
Nick Sweeting
a3b12e691f
Updated Scheduled Archiving (markdown)
2024-02-18 18:14:14 -08:00
Nick Sweeting
ab207a2c7f
Updated Scheduled Archiving (markdown)
2024-01-04 12:58:50 -08:00
Nick Sweeting
b7a368bfae
build docs
2023-11-13 23:47:38 -08:00
Nick Sweeting
cd8574625f
Updated Scheduled Archiving (markdown)
2023-10-05 17:32:23 -07:00
Nick Sweeting
6098013abe
Updated Scheduled Archiving (markdown)
2023-10-05 17:30:00 -07:00
Nick Sweeting
e6befbb433
Updated Scheduled Archiving (markdown)
2022-04-12 20:17:12 -04:00
Nick Sweeting
520677ebae
Updated Scheduled Archiving (markdown)
2022-04-12 20:07:37 -04:00
Nick Sweeting
9a348dfe47
Updated Scheduled Archiving (markdown)
2022-04-12 20:07:05 -04:00
Nick Sweeting
e5534d57a1
Updated Scheduled Archiving (markdown)
2022-04-12 20:06:52 -04:00
Nick Sweeting
dc9e128927
Updated Scheduled Archiving (markdown)
2022-04-12 20:01:04 -04:00
Nick Sweeting
6c54fca67e
update url paths
2020-11-23 02:06:24 -05:00
Mirwaisse Djanbaz
bf0df2d4dd
Typo
2020-10-31 10:23:39 +01:00
David BELEY
f155253143
Use correct timespan in pocket example description.
2020-08-14 22:42:07 +00:00
Michael Peteuil
9d9179cab7
Updated Scheduled Archiving (markdown)
2020-08-09 22:37:09 -04:00
Nick Sweeting
f1b6bf6758
add sphinx documentation setup
2019-04-28 16:45:47 -04:00
Nick Sweeting
467adc21bb
Updated Scheduled Archiving (markdown)
2019-02-26 22:05:48 -05:00
Nick Sweeting
242e05dd72
Updated Scheduled Archiving (markdown)
2019-01-23 02:51:36 -05:00
Nick Sweeting
c3b46b20cf
Updated Scheduled Archiving (markdown)
2019-01-23 02:51:03 -05:00
Nick Sweeting
20272a3d75
Updated Scheduled Archiving (markdown)
2019-01-23 02:50:42 -05:00
Nick Sweeting
052eb3212f
Updated Scheduled Archiving (markdown)
2019-01-23 02:50:10 -05:00
Nick Sweeting
96d51bf134
Updated Scheduled archiving (markdown)
2019-01-23 02:30:07 -05:00
