working docs build

Contents.rst

@@ -0,0 +1,71 @@
+Intro
+#####
+
+.. toctree::
+    :maxdepth: 1
+
+    README.md
+
+
+Getting Started
+###############
+
+.. toctree::
+    :maxdepth: 2
+
+    Quickstart.md
+    Install.md
+    Docker.md
+
+
+General
+#######
+
+.. toctree::
+    :maxdepth: 2
+
+    Usage.md
+    Configuration.md
+    Troubleshooting.md
+    Security-Overview.md
+    Publishing-Your-Archive.md
+    Scheduled-Archiving.md
+    Chromium-Install.md
+
+
+API Reference
+#############
+
+.. toctree::
+    :maxdepth: 1
+
+    Configuration Options <Configuration.md>
+    Data Folder Layout <Usage.md>
+    Command Line Interface <Usage.md>
+    Web Interface <Usage.md>
+    Python API <modules>
+    REST API <modules>
+
+.. - [Configuration Options](Configuration.md)
+.. - [Data Folder Layout](Configuration.md)
+.. - [Command Line Interface](Usage.md)
+.. - [Web Interface](Usage.md)
+.. - [Python API](modules)
+.. - REST API (Coming soon...)
+
+
+Meta
+####
+
+.. toctree::
+    :maxdepth: 1
+
+    Roadmap.md
+    Changelog.md
+    Donations.md
+
+
+.. toctree::
+    :maxdepth: 3
+
+    Web-Archiving-Community.md

Docker.md

@@ -88,7 +88,7 @@ ArchiveBox running with docker-compose accepts all the same environment variable
 The recommended way to pass in config variables is to edit the `environment:` section in `docker-compose.yml` directly or add an `env_file: ./path/to/ArchiveBox.conf` line before `environment:` to import variables from an env file.
 
 Example of adding config options to `docker-compose.yml`:
-```yml
+```yaml
 ...
 
 services:

conf.py

@@ -36,6 +36,7 @@ copyright = '2019, Nick Sweeting'
 author = 'Nick Sweeting'
 github_url = 'https://github.com/pirate/ArchiveBox'
 github_doc_root = 'https://github.com/pirate/ArchiveBox/wiki'
+language = 'en'
 
 # The full version, including alpha/beta/rc tags
 release = VERSION
@@ -50,8 +51,7 @@ extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.napoleon',
     'sphinx.ext.viewcode',
-    # 'sphinxcontrib.blockdiag'
-    'recommonmark'
+    'recommonmark',
 ]
 
 source_suffix = {
@@ -91,7 +91,12 @@ exclude_patterns = [
 #
 html_logo = 'logo.png'
 html_theme = 'sphinx_rtd_theme'
-html_theme_options = {}
+html_theme_options = {
+    'navigation_depth': 5,
+    'collapse_navigation': False,
+    'sticky_navigation': True,
+}
+html_show_sphinx = False
 
 texinfo_documents = [
     (master_doc, 'archivebox', 'archivebox Documentation',
@@ -99,7 +104,12 @@ texinfo_documents = [
      'Miscellaneous'),
 ]
 
-pygments_style = 'friendly'
+autodoc_default_flags = ['members']
+autodoc_member_order = 'bysource'
+extensions += ['sphinx.ext.autosummary',]
+autosummary_gerenerate = True
+
+pygments_style = 'sphinx'
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
@@ -119,6 +129,6 @@ man_pages = [
 def setup(app):
     app.add_config_value('recommonmark_config', {
             # 'url_resolver': lambda url: github_doc_root + url,
-            'auto_toc_tree_section': 'ArchiveBox Documentation',
+            'auto_toc_tree_section': 'Documentation',
             }, True)
     app.add_transform(AutoStructify)

index.md

@@ -1,59 +0,0 @@
-``` sidebar:: Welcome to ArchiveBox!
-
-     Just getting started?
-       Check out the Quickstart page.
-     Need help with something?
-       Ping us on Twitter or Github.
-     Want to join the community?
-       See our Community Wiki page.
-```
-
-
-## Meta
-
-```eval_rst
-.. toctree::
-    :maxdepth: 1
-
-    Readme <README.md>
-    Roadmap.md
-    Changelog.md
-    Donations.md
-    Web-Archiving-Community.md
-```
-
-## Getting Started
-```eval_rst
-.. toctree::
-    :maxdepth: 2
-
-    Quickstart.md
-    Install.md
-    Docker.md
-```
-
-
-## General
-
-```eval_rst
-.. toctree::
-    :maxdepth: 2
-
-    Usage.md
-    Configuration.md
-    Troubleshooting.md
-    Security-Overview.md
-    Publishing-Your-Archive.md
-    Scheduled-Archiving.md
-    Chromium-Install.md
-```
-
-
-## API Reference
-
-* [Configuration Options](Configuration.md)
-* [Data Folder Layout](Configuration.md)
-* [Command Line Interface](Usage.md)
-* [Web Interface](Usage.md)
-* [Python API](modules)
-* REST API (Coming soon...)

index.rst

@@ -0,0 +1,40 @@
+.. sidebar:: Welcome to ArchiveBox!
+    
+    Just getting started?
+        Check out the `Quickstart <Quickstart.html>`_ guide.
+    Need help with something?
+        Ping us on `Twitter <https://twitter.com/theSquashSH>`_ or `Github <https://github.com/pirate/ArchiveBox/issues>`_.
+    Want to join the community?
+        See our `Community Wiki <https://github.com/pirate/ArchiveBox/wiki/Web-Archiving-Community>`_ page.
+
+    .. image:: logo.png
+        :width: 200px
+        :align: center
+        :alt: ArchiveBox Logo
+
+==========
+ArchiveBox
+==========
+
+    "The open-source self-hosted internet archive."
+
+`Website <https://archivebox.io>`_ | `Github <https://github.com/pirate/ArchiveBox>`_ | `Source <https://github.com/pirate/ArchiveBox/tree/master>`_ | `Bug Tracker <https://github.com/pirate/ArchiveBox/issues>`_
+
+.. code-block:: bash
+    
+    mkdir my-archive; cd my-archive/
+    pip install archivebox
+
+    archivebox init
+    archivebox add https://example.com
+    archivebox info
+
+
+=============
+Documentation
+=============
+
+.. toctree::
+    :maxdepth: 2
+    
+    Contents.rst