mirror of
https://github.com/ArchiveBox/ArchiveBox
synced 2024-11-10 14:44:18 +00:00
fix docs to use read-the-docs theme
This commit is contained in:
Nick Sweeting
parent
d4c4a2d4ac
commit
248a4da99d
13 changed files with 284 additions and 185 deletions
2
Pipfile
2
Pipfile
|
|
@ -11,7 +11,7 @@ django-stubs = "*"
|
|||
setuptools = "*"
|
||||
sphinx = "*"
|
||||
recommonmark = "*"
|
||||
sphinx-py3doc-enhanced-theme = "*"
|
||||
sphinx-rtd-theme = "*"
|
||||
|
||||
[packages]
|
||||
dataclasses = "*"
|
||||
|
|
|
|||
10
Pipfile.lock
generated
10
Pipfile.lock
generated
|
|
@ -1,7 +1,7 @@
|
|||
{
|
||||
"_meta": {
|
||||
"hash": {
|
||||
"sha256": "d08536bbf021815da1c2eac98b891c0992e1540b340ee69970ecd626ee3e9eec"
|
||||
"sha256": "8ac4f9e5cd266406a861a283b321b9eee0ca469638f838e93467403ef2f0594d"
|
||||
},
|
||||
"pipfile-spec": 6,
|
||||
"requires": {
|
||||
|
|
@ -536,13 +536,13 @@
|
|||
"index": "pypi",
|
||||
"version": "==2.0.1"
|
||||
},
|
||||
"sphinx-py3doc-enhanced-theme": {
|
||||
"sphinx-rtd-theme": {
|
||||
"hashes": [
|
||||
"sha256:0a0dc9b81d047c10f9a44a0f85df409afedc804751924a21c781d323e14aaf18",
|
||||
"sha256:170ac7aad9c8f61c4400b7ec64d2b944c2158ad328d725818095c42950a3675c"
|
||||
"sha256:00cf895504a7895ee433807c62094cf1e95f065843bf3acd17037c3e9a2becd4",
|
||||
"sha256:728607e34d60456d736cc7991fd236afb828b21b82f956c5ea75f94c8414040a"
|
||||
],
|
||||
"index": "pypi",
|
||||
"version": "==2.4.0"
|
||||
"version": "==0.4.3"
|
||||
},
|
||||
"sphinxcontrib-applehelp": {
|
||||
"hashes": [
|
||||
|
|
|
|||
|
|
@ -116,6 +116,22 @@ 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
|
||||
---------------
|
||||
|
|
|
|||
22
archivebox/docs/archivebox.config.rst
Normal file
22
archivebox/docs/archivebox.config.rst
Normal file
|
|
@ -0,0 +1,22 @@
|
|||
archivebox.config package
|
||||
=========================
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
archivebox.config.stubs module
|
||||
------------------------------
|
||||
|
||||
.. automodule:: archivebox.config.stubs
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: archivebox.config
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
86
archivebox/docs/archivebox.extractors.rst
Normal file
86
archivebox/docs/archivebox.extractors.rst
Normal file
|
|
@ -0,0 +1,86 @@
|
|||
archivebox.extractors package
|
||||
=============================
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
archivebox.extractors.archive\_org module
|
||||
-----------------------------------------
|
||||
|
||||
.. automodule:: archivebox.extractors.archive_org
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
archivebox.extractors.dom module
|
||||
--------------------------------
|
||||
|
||||
.. automodule:: archivebox.extractors.dom
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
archivebox.extractors.favicon module
|
||||
------------------------------------
|
||||
|
||||
.. automodule:: archivebox.extractors.favicon
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
archivebox.extractors.git module
|
||||
--------------------------------
|
||||
|
||||
.. automodule:: archivebox.extractors.git
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
archivebox.extractors.media module
|
||||
----------------------------------
|
||||
|
||||
.. automodule:: archivebox.extractors.media
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
archivebox.extractors.pdf module
|
||||
--------------------------------
|
||||
|
||||
.. automodule:: archivebox.extractors.pdf
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
archivebox.extractors.screenshot module
|
||||
---------------------------------------
|
||||
|
||||
.. automodule:: archivebox.extractors.screenshot
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
archivebox.extractors.title module
|
||||
----------------------------------
|
||||
|
||||
.. automodule:: archivebox.extractors.title
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
archivebox.extractors.wget module
|
||||
---------------------------------
|
||||
|
||||
.. automodule:: archivebox.extractors.wget
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: archivebox.extractors
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
46
archivebox/docs/archivebox.index.rst
Normal file
46
archivebox/docs/archivebox.index.rst
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
archivebox.index package
|
||||
========================
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
archivebox.index.html module
|
||||
----------------------------
|
||||
|
||||
.. automodule:: archivebox.index.html
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
archivebox.index.json module
|
||||
----------------------------
|
||||
|
||||
.. automodule:: archivebox.index.json
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
archivebox.index.schema module
|
||||
------------------------------
|
||||
|
||||
.. automodule:: archivebox.index.schema
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
archivebox.index.sql module
|
||||
---------------------------
|
||||
|
||||
.. automodule:: archivebox.index.sql
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: archivebox.index
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
|
@ -1,93 +0,0 @@
|
|||
archivebox.legacy package
|
||||
=========================
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
|
||||
archivebox.legacy.storage
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
archivebox.legacy.archive\_methods module
|
||||
-----------------------------------------
|
||||
|
||||
.. automodule:: archivebox.legacy.archive_methods
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
archivebox.legacy.config module
|
||||
-------------------------------
|
||||
|
||||
.. automodule:: archivebox.legacy.config
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
archivebox.legacy.config\_stubs module
|
||||
--------------------------------------
|
||||
|
||||
.. automodule:: archivebox.legacy.config_stubs
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
archivebox.legacy.index module
|
||||
------------------------------
|
||||
|
||||
.. automodule:: archivebox.legacy.index
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
archivebox.legacy.logs module
|
||||
-----------------------------
|
||||
|
||||
.. automodule:: archivebox.legacy.logs
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
archivebox.legacy.main module
|
||||
-----------------------------
|
||||
|
||||
.. automodule:: archivebox.legacy.main
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
archivebox.legacy.parse module
|
||||
------------------------------
|
||||
|
||||
.. automodule:: archivebox.legacy.parse
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
archivebox.legacy.schema module
|
||||
-------------------------------
|
||||
|
||||
.. automodule:: archivebox.legacy.schema
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
archivebox.legacy.util module
|
||||
-----------------------------
|
||||
|
||||
.. automodule:: archivebox.legacy.util
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: archivebox.legacy
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
|
@ -1,38 +0,0 @@
|
|||
archivebox.legacy.storage package
|
||||
=================================
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
archivebox.legacy.storage.html module
|
||||
-------------------------------------
|
||||
|
||||
.. automodule:: archivebox.legacy.storage.html
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
archivebox.legacy.storage.json module
|
||||
-------------------------------------
|
||||
|
||||
.. automodule:: archivebox.legacy.storage.json
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
archivebox.legacy.storage.sql module
|
||||
------------------------------------
|
||||
|
||||
.. automodule:: archivebox.legacy.storage.sql
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: archivebox.legacy.storage
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
78
archivebox/docs/archivebox.parsers.rst
Normal file
78
archivebox/docs/archivebox.parsers.rst
Normal file
|
|
@ -0,0 +1,78 @@
|
|||
archivebox.parsers package
|
||||
==========================
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
archivebox.parsers.generic\_json module
|
||||
---------------------------------------
|
||||
|
||||
.. automodule:: archivebox.parsers.generic_json
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
archivebox.parsers.generic\_rss module
|
||||
--------------------------------------
|
||||
|
||||
.. automodule:: archivebox.parsers.generic_rss
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
archivebox.parsers.generic\_txt module
|
||||
--------------------------------------
|
||||
|
||||
.. automodule:: archivebox.parsers.generic_txt
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
archivebox.parsers.medium\_rss module
|
||||
-------------------------------------
|
||||
|
||||
.. automodule:: archivebox.parsers.medium_rss
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
archivebox.parsers.netscape\_html module
|
||||
----------------------------------------
|
||||
|
||||
.. automodule:: archivebox.parsers.netscape_html
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
archivebox.parsers.pinboard\_rss module
|
||||
---------------------------------------
|
||||
|
||||
.. automodule:: archivebox.parsers.pinboard_rss
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
archivebox.parsers.pocket\_html module
|
||||
--------------------------------------
|
||||
|
||||
.. automodule:: archivebox.parsers.pocket_html
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
archivebox.parsers.shaarli\_rss module
|
||||
--------------------------------------
|
||||
|
||||
.. automodule:: archivebox.parsers.shaarli_rss
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: archivebox.parsers
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
|
@ -7,12 +7,23 @@ Subpackages
|
|||
.. toctree::
|
||||
|
||||
archivebox.cli
|
||||
archivebox.config
|
||||
archivebox.core
|
||||
archivebox.legacy
|
||||
archivebox.extractors
|
||||
archivebox.index
|
||||
archivebox.parsers
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
archivebox.main module
|
||||
----------------------
|
||||
|
||||
.. automodule:: archivebox.main
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
archivebox.manage module
|
||||
------------------------
|
||||
|
||||
|
|
@ -21,10 +32,10 @@ archivebox.manage module
|
|||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
archivebox.tests module
|
||||
-----------------------
|
||||
archivebox.util module
|
||||
----------------------
|
||||
|
||||
.. automodule:: archivebox.tests
|
||||
.. automodule:: archivebox.util
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ source_suffix = {
|
|||
'.txt': 'markdown',
|
||||
'.md': 'markdown',
|
||||
}
|
||||
master_doc = 'index'
|
||||
master_doc = 'archivebox'
|
||||
napoleon_google_docstring = True
|
||||
napoleon_use_param = True
|
||||
napoleon_use_ivar = False
|
||||
|
|
@ -63,7 +63,16 @@ templates_path = ['_templates']
|
|||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
# This pattern also affects html_static_path and html_extra_path.
|
||||
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'data', 'output', 'templates', 'tests']
|
||||
exclude_patterns = [
|
||||
'_build',
|
||||
'Thumbs.db',
|
||||
'.DS_Store',
|
||||
'data',
|
||||
'output',
|
||||
'templates',
|
||||
'tests',
|
||||
'migrations',
|
||||
]
|
||||
|
||||
|
||||
# -- Options for HTML output -------------------------------------------------
|
||||
|
|
@ -71,8 +80,10 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'data', 'output', 'templ
|
|||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
#
|
||||
html_theme = 'sphinx_py3doc_enhanced_theme'
|
||||
html_theme_path = [sphinx_py3doc_enhanced_theme.get_html_theme_path()]
|
||||
github_url = 'https://github.com/pirate/ArchiveBox'
|
||||
html_logo = '../themes/static/archive.png'
|
||||
html_theme = 'sphinx_rtd_theme'
|
||||
html_theme_options = {}
|
||||
|
||||
texinfo_documents = [
|
||||
(master_doc, 'archivebox', 'archivebox Documentation',
|
||||
|
|
@ -80,17 +91,6 @@ texinfo_documents = [
|
|||
'Miscellaneous'),
|
||||
]
|
||||
|
||||
html_theme_options = {
|
||||
'githuburl': 'https://github.com/ionelmc/sphinx-py3doc-enhanced-theme/',
|
||||
'bodyfont': '"Lucida Grande",Arial,sans-serif',
|
||||
'headfont': '"Lucida Grande",Arial,sans-serif',
|
||||
'codefont': '"Deja Vu Sans Mono",consolas,monospace,sans-serif',
|
||||
'linkcolor': '#0072AA',
|
||||
'visitedlinkcolor': '#6363bb',
|
||||
'extrastyling': False,
|
||||
'sidebarwide': True
|
||||
|
||||
}
|
||||
pygments_style = 'friendly'
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
|
|
|
|||
|
|
@ -1,27 +0,0 @@
|
|||
.. ArchiveBox documentation master file, created by
|
||||
sphinx-quickstart on Fri Apr 26 20:28:45 2019.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
Welcome to ArchiveBox's documentation!
|
||||
======================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Contents:
|
||||
|
||||
archivebox
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
|
||||
.. automodule:: archivebox
|
||||
:members:
|
||||
:inherited-members:
|
||||
:show-inheritance:
|
||||
|
||||
archivebox
|
||||
|
|
@ -454,7 +454,6 @@ def add(import_str: Optional[str]=None,
|
|||
update_all: bool=not ONLY_NEW,
|
||||
index_only: bool=False,
|
||||
out_dir: str=OUTPUT_DIR) -> List[Link]:
|
||||
"""The main ArchiveBox entrancepoint. Everything starts here."""
|
||||
|
||||
check_data_folder(out_dir=out_dir)
|
||||
|
||||
|
|
@ -597,7 +596,6 @@ def update(resume: Optional[float]=None,
|
|||
after: Optional[str]=None,
|
||||
before: Optional[str]=None,
|
||||
out_dir: str=OUTPUT_DIR) -> List[Link]:
|
||||
"""The main ArchiveBox entrancepoint. Everything starts here."""
|
||||
|
||||
check_dependencies()
|
||||
check_data_folder(out_dir=out_dir)
|
||||
|
|
|
|||
Loading…
Reference in a new issue