build docs

pirate · pirate · commit b7a368bfae50 · 2023-11-13T23:47:38.000-08:00
diff --git a/Configuration.md b/Configuration.md
@@ -5,7 +5,7 @@
 Configuration of ArchiveBox is done by using the `archivebox config` command, modifying the `ArchiveBox.conf` file in the data folder, or by using environment variables. All three methods work equivalently when using Docker as well.
 
 *Some equivalent examples of setting some configuration options:*
-```bash[][]
+```bash
 archivebox config --set CHROME_BINARY=google-chrome-stable
 # OR
 echo "CHROME_BINARY=google-chrome-stable" >> ArchiveBox.conf
diff --git a/Contents.rst b/Contents.rst
@@ -31,6 +31,7 @@ General
     Publishing-Your-Archive.md
     Scheduled-Archiving.md
     Chromium-Install.md
+    Upgrading-or-Merging-Archives.md
 
 
 API Reference
diff --git a/Docker.md b/Docker.md
@@ -8,7 +8,7 @@ Make sure you have Docker installed and set up on your machine before following
 
 <img src="https://i.imgur.com/qFAPRwC.png" width="20%" align="right">
 
-- [Overview](#)
+- [Overview](#Overview)
 - [Docker Compose](#docker-compose) (recommended way)
   - [Setup](#setup)
   - [Upgrading](https://github.com/ArchiveBox/ArchiveBox/wiki/Upgrading-or-Merging-Archives#upgrading-with-docker-compose-%EF%B8%8F)
diff --git a/Scheduled-Archiving.md b/Scheduled-Archiving.md
@@ -14,7 +14,7 @@ positional arguments:
 
 optional arguments:
   -h, --help        show this help message and exit
-  --quiet, -q       Don't warn about storage space.
+  --quiet, -q       Dont warn about storage space.
   --add             Add a new scheduled ArchiveBox update job to cron
   --every EVERY     Run ArchiveBox once every [timeperiod] (hour/day/month/year or cron format e.g. "0 0 * * *")
   --depth {0,1}     Depth to archive to [0] or 1, see "add" command help for more info
diff --git a/Upgrading-or-Merging-Archives.md b/Upgrading-or-Merging-Archives.md
@@ -252,7 +252,7 @@ More info:
 #### Database and filesystem contention issues when running multiple ArchiveBox processes
 
 ArchiveBox can sometimes struggle when archiving many links in parallel with multiple ArchiveBox processes trying to write to the database at the same time, leading to errors like this:
-```logs
+```bash
 Unable to create the django_migrations table (database is locked)
 ```
 
@@ -305,7 +305,7 @@ More info:
 A corrupted database file can theoretically only happen if an external process or filesystem error corrupts the SQLite3 database (there has only been [one report](https://github.com/ArchiveBox/ArchiveBox/issues/955) of a user encountering this in real life). If you ever need to repair a corrupted ArchiveBox index you can run the following steps.
 
 Note this is specific to this error, these steps do not apply to other migrations/db errors (see below for other issues):
-```logs
+```bash
 sqlite3.DatabaseError: database disk image is malformed    
 ```
 
diff --git a/Web-Archiving-Community.md b/Web-Archiving-Community.md
@@ -341,7 +341,7 @@ If any of these links are dead, you can find an archived version on https://arch
  - **Reddit r/DataHoarder, r/SelfHosted, etc. posts and comments**:  
    [#1](https://www.reddit.com/r/DataHoarder/comments/69e6i9/archive_a_browseable_copy_of_your_saved_pocket/), [#2](https://www.reddit.com/r/DataHoarder/comments/6kepv6/bookmarkarchiver_now_supports_archiving_all_major/), [#3](https://www.reddit.com/r/DataHoarder/comments/apnud4/continually_archive_websites_and_keep_the_older/), [#4](https://www.reddit.com/r/DataHoarder/comments/azdhd9/archivebox_open_source_selfhosted_web_archive/), [#5](https://www.reddit.com/r/DataHoarder/comments/b0o10h/archivebox_self_hosting_clone_of_archiveorg/) , **[#6](https://www.reddit.com/r/DataHoarder/comments/b4nrlc/in_case_you_havent_seen_it_archivebox_has_a/)**, [#7](https://www.reddit.com/r/selfhosted/comments/69eoi3/pocket_stream_archive_your_own_personal_wayback/), [#8](https://www.reddit.com/r/selfhosted/comments/an2368/archivebox_the_opensource_selfhosted_web_archive/), [and many more...](https://www.google.com/search?q=site%3Areddit.com+%22archivebox%22)
  - **Twitter:**  
-   [Python Trending](https://twitter.com/pythontrending/status/1092492387182628865), [PyCoder's Weekly](https://twitter.com/pycoders/status/1105803699799105536), [Python Hub](https://twitter.com/PythonHub/status/1107601343395651589), [Smashing Magazine](https://twitter.com/smashingmag/status/1107990604774928386), [and many more...]([Twitter](https://twitter.com/search?l=&q=archivebox.io%20OR%20pirate%2Farchivebox%20OR%20archivebox&src=typd))
+   [Python Trending](https://twitter.com/pythontrending/status/1092492387182628865), [PyCoder's Weekly](https://twitter.com/pycoders/status/1105803699799105536), [Python Hub](https://twitter.com/PythonHub/status/1107601343395651589), [Smashing Magazine](https://twitter.com/smashingmag/status/1107990604774928386), <a href="https://twitter.com/search?q=archivebox.io%20OR%20archivebox%2Farchivebox%20OR%20archiveboxapp&src=typed_query&f=live">and many more...</a>
 
 
 ---
diff --git a/_static/icon.png b/_static/icon.png
diff --git a/archivebox.cli.rst b/archivebox.cli.rst
@@ -4,14 +4,6 @@ archivebox.cli package
 Submodules
 ----------
 
-archivebox.cli.archivebox module
---------------------------------
-
-.. automodule:: archivebox.cli.archivebox
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 archivebox.cli.archivebox\_add module
 -------------------------------------
 
@@ -36,10 +28,10 @@ archivebox.cli.archivebox\_help module
     :undoc-members:
     :show-inheritance:
 
-archivebox.cli.archivebox\_info module
---------------------------------------
+archivebox.cli.archivebox\_status module
+----------------------------------------
 
-.. automodule:: archivebox.cli.archivebox_info
+.. automodule:: archivebox.cli.archivebox_status
     :members:
     :undoc-members:
     :show-inheritance:
@@ -116,22 +108,6 @@ archivebox.cli.archivebox\_version module
     :undoc-members:
     :show-inheritance:
 
-archivebox.cli.logging module
------------------------------
-
-.. automodule:: archivebox.cli.logging
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-archivebox.cli.tests module
----------------------------
-
-.. automodule:: archivebox.cli.tests
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 
 Module contents
 ---------------
diff --git a/archivebox.config.rst b/archivebox.config.rst
@@ -4,14 +4,6 @@ archivebox.config package
 Submodules
 ----------
 
-archivebox.config.stubs module
-------------------------------
-
-.. automodule:: archivebox.config.stubs
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 
 Module contents
 ---------------
@@ -20,3 +12,11 @@ Module contents
     :members:
     :undoc-members:
     :show-inheritance:
+
+archivebox.config.stubs module
+------------------------------
+
+.. automodule:: archivebox.config_stubs
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/archivebox.core.rst b/archivebox.core.rst
@@ -27,14 +27,6 @@ archivebox.core.apps module
     :undoc-members:
     :show-inheritance:
 
-archivebox.core.models module
------------------------------
-
-.. automodule:: archivebox.core.models
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 archivebox.core.settings module
 -------------------------------
 
diff --git a/conf.py b/conf.py
@@ -25,8 +25,10 @@
 ROOT_DIR = os.path.abspath(os.path.join(os.path.dirname(os.path.abspath(__file__)), '..'))
 PACKAGE_DIR = os.path.join(ROOT_DIR, 'archivebox')
 
+os.chdir(ROOT_DIR)
+
 sys.path.insert(0, os.path.abspath('.'))
-sys.path.insert(0, os.path.abspath('../'))
+sys.path.insert(0, os.path.abspath('..'))
 sys.path.insert(0, PACKAGE_DIR)
 os.environ.setdefault("DJANGO_SETTINGS_MODULE", "core.settings")
 django.setup()
@@ -36,7 +38,7 @@
 # -- Project information -----------------------------------------------------
 
 project = 'ArchiveBox'
-copyright = '2020, Nick Sweeting'
+copyright = '2023 ©️ ArchiveBox ™️'
 author = 'Nick Sweeting'
 github_url = 'https://github.com/ArchiveBox/ArchiveBox'
 github_doc_root = 'https://github.com/ArchiveBox/ArchiveBox/tree/master/docs/'
