diff --git a/.gitignore b/.gitignore index d44c22ec..405d2222 100644 --- a/.gitignore +++ b/.gitignore @@ -9,6 +9,7 @@ venv .venv archivebox/.venv archivebox/venv +archivebox/docs/_build # vim .swp* diff --git a/Pipfile b/Pipfile index b6ce9ab3..3001b997 100644 --- a/Pipfile +++ b/Pipfile @@ -9,6 +9,9 @@ flake8 = "*" mypy = "*" django-stubs = "*" setuptools = "*" +sphinx = "*" +recommonmark = "*" +sphinx-py3doc-enhanced-theme = "*" [packages] dataclasses = "*" diff --git a/Pipfile.lock b/Pipfile.lock index d6516e8b..44086156 100644 --- a/Pipfile.lock +++ b/Pipfile.lock @@ -1,7 +1,7 @@ { "_meta": { "hash": { - "sha256": "ad0264907c26fe4227c5c0b6376733422b4e506a9eef057e0a563428373046dd" + "sha256": "d08536bbf021815da1c2eac98b891c0992e1540b340ee69970ecd626ee3e9eec" }, "pipfile-spec": 6, "requires": { @@ -80,11 +80,11 @@ }, "ipython": { "hashes": [ - "sha256:b038baa489c38f6d853a3cfc4c635b0cda66f2864d136fe8f40c1a6e334e2a6b", - "sha256:f5102c1cd67e399ec8ea66bcebe6e3968ea25a8977e53f012963e5affeb1fe38" + "sha256:54c5a8aa1eadd269ac210b96923688ccf01ebb2d0f21c18c3c717909583579a8", + "sha256:e840810029224b56cd0d9e7719dc3b39cf84d577f8ac686547c8ba7a06eeab26" ], "index": "pypi", - "version": "==7.4.0" + "version": "==7.5.0" }, "ipython-genutils": { "hashes": [ @@ -211,6 +211,13 @@ } }, "develop": { + "alabaster": { + "hashes": [ + "sha256:446438bdcca0e05bd45ea2de1668c1d9b032e1a9154c2c259092d77031ddd359", + "sha256:a661d72d58e6ea8a57f7a86e37d86716863ee5e92788398526d58b26a4e4dc02" + ], + "version": "==0.7.12" + }, "appnope": { "hashes": [ "sha256:5b26757dc6f79a3b7dc9fab95359328d5747fcb2409d331ea66d0272b90ab2a0", @@ -219,6 +226,13 @@ "markers": "sys_platform == 'darwin'", "version": "==0.1.0" }, + "babel": { + "hashes": [ + "sha256:6778d85147d5d85345c14a26aada5e478ab04e39b078b0745ee6870c2b5cf669", + "sha256:8cba50f48c529ca3fa18cf81fa9403be176d374ac4d60738b839122dfaaa3d23" + ], + "version": "==2.6.0" + }, "backcall": { "hashes": [ "sha256:38ecd85be2c1e78f77fd91700c76e14667dc21e2713b63876c0eb901196e01e4", @@ -226,6 +240,27 @@ ], "version": "==0.1.0" }, + "certifi": { + "hashes": [ + "sha256:59b7658e26ca9c7339e00f8f4636cdfe59d34fa37b9b04f6f9e9926b3cece1a5", + "sha256:b26104d6835d1f5e49452a26eb2ff87fe7090b89dfcaee5ea2212697e1e1d7ae" + ], + "version": "==2019.3.9" + }, + "chardet": { + "hashes": [ + "sha256:84ab92ed1c4d4f16916e05906b6b75a6c0fb5db821cc65e70cbd64a3e2a5eaae", + "sha256:fc323ffcaeaed0e0a02bf4d117757b98aed530d9ed4531e3e15460124c106691" + ], + "version": "==3.0.4" + }, + "commonmark": { + "hashes": [ + "sha256:9f6dda7876b2bb88dd784440166f4bc8e56cb2b2551264051123bacb0b6c1d8a", + "sha256:abcbc854e0eae5deaf52ae5e328501b78b4a0758bf98ac8bb792fce993006084" + ], + "version": "==0.8.1" + }, "decorator": { "hashes": [ "sha256:86156361c50488b84a3f148056ea716ca587df2f0de1d34750d35c21312725de", @@ -241,6 +276,14 @@ "index": "pypi", "version": "==0.12.1" }, + "docutils": { + "hashes": [ + "sha256:02aec4bd92ab067f6ff27a38a38a41173bf01bed8f89157768c1573f53e474a6", + "sha256:51e64ef2ebfb29cae1faa133b3710143496eca21c530f3f71424d77687764274", + "sha256:7a4bd47eaf6596e1295ecb11361139febe29b084a87bf005bf899f9a42edc3c6" + ], + "version": "==0.14" + }, "entrypoints": { "hashes": [ "sha256:589f874b313739ad35be6e0cd7efde2a4e9b6fea91edcc34e58ecbb8dbe56d19", @@ -256,6 +299,26 @@ "index": "pypi", "version": "==3.7.7" }, + "future": { + "hashes": [ + "sha256:67045236dcfd6816dc439556d009594abf643e5eb48992e36beac09c2ca659b8" + ], + "version": "==0.17.1" + }, + "idna": { + "hashes": [ + "sha256:c357b3f628cf53ae2c4c05627ecc484553142ca23264e593d327bcde5e9c3407", + "sha256:ea8b7f6188e6fa117537c3df7da9fc686d485087abf6ac197f9c46432f7e4a3c" + ], + "version": "==2.8" + }, + "imagesize": { + "hashes": [ + "sha256:3f349de3eb99145973fefb7dbe38554414e5c30abd0c8e4b970a7c9d09f3a1d8", + "sha256:f3832918bc3c66617f92e35f5d70729187676313caa60c187eb0f28b8fe5e3b5" + ], + "version": "==1.1.0" + }, "ipdb": { "hashes": [ "sha256:dce2112557edfe759742ca2d0fee35c59c97b0cc7a05398b791079d78f1519ce" @@ -265,11 +328,11 @@ }, "ipython": { "hashes": [ - "sha256:b038baa489c38f6d853a3cfc4c635b0cda66f2864d136fe8f40c1a6e334e2a6b", - "sha256:f5102c1cd67e399ec8ea66bcebe6e3968ea25a8977e53f012963e5affeb1fe38" + "sha256:54c5a8aa1eadd269ac210b96923688ccf01ebb2d0f21c18c3c717909583579a8", + "sha256:e840810029224b56cd0d9e7719dc3b39cf84d577f8ac686547c8ba7a06eeab26" ], "index": "pypi", - "version": "==7.4.0" + "version": "==7.5.0" }, "ipython-genutils": { "hashes": [ @@ -285,6 +348,46 @@ ], "version": "==0.13.3" }, + "jinja2": { + "hashes": [ + "sha256:065c4f02ebe7f7cf559e49ee5a95fb800a9e4528727aec6f24402a5374c65013", + "sha256:14dd6caf1527abb21f08f86c784eac40853ba93edb79552aa1e4b8aef1b61c7b" + ], + "version": "==2.10.1" + }, + "markupsafe": { + "hashes": [ + "sha256:00bc623926325b26bb9605ae9eae8a215691f33cae5df11ca5424f06f2d1f473", + "sha256:09027a7803a62ca78792ad89403b1b7a73a01c8cb65909cd876f7fcebd79b161", + "sha256:09c4b7f37d6c648cb13f9230d847adf22f8171b1ccc4d5682398e77f40309235", + "sha256:1027c282dad077d0bae18be6794e6b6b8c91d58ed8a8d89a89d59693b9131db5", + "sha256:24982cc2533820871eba85ba648cd53d8623687ff11cbb805be4ff7b4c971aff", + "sha256:29872e92839765e546828bb7754a68c418d927cd064fd4708fab9fe9c8bb116b", + "sha256:43a55c2930bbc139570ac2452adf3d70cdbb3cfe5912c71cdce1c2c6bbd9c5d1", + "sha256:46c99d2de99945ec5cb54f23c8cd5689f6d7177305ebff350a58ce5f8de1669e", + "sha256:500d4957e52ddc3351cabf489e79c91c17f6e0899158447047588650b5e69183", + "sha256:535f6fc4d397c1563d08b88e485c3496cf5784e927af890fb3c3aac7f933ec66", + "sha256:62fe6c95e3ec8a7fad637b7f3d372c15ec1caa01ab47926cfdf7a75b40e0eac1", + "sha256:6dd73240d2af64df90aa7c4e7481e23825ea70af4b4922f8ede5b9e35f78a3b1", + "sha256:717ba8fe3ae9cc0006d7c451f0bb265ee07739daf76355d06366154ee68d221e", + "sha256:79855e1c5b8da654cf486b830bd42c06e8780cea587384cf6545b7d9ac013a0b", + "sha256:7c1699dfe0cf8ff607dbdcc1e9b9af1755371f92a68f706051cc8c37d447c905", + "sha256:88e5fcfb52ee7b911e8bb6d6aa2fd21fbecc674eadd44118a9cc3863f938e735", + "sha256:8defac2f2ccd6805ebf65f5eeb132adcf2ab57aa11fdf4c0dd5169a004710e7d", + "sha256:98c7086708b163d425c67c7a91bad6e466bb99d797aa64f965e9d25c12111a5e", + "sha256:9add70b36c5666a2ed02b43b335fe19002ee5235efd4b8a89bfcf9005bebac0d", + "sha256:9bf40443012702a1d2070043cb6291650a0841ece432556f784f004937f0f32c", + "sha256:ade5e387d2ad0d7ebf59146cc00c8044acbd863725f887353a10df825fc8ae21", + "sha256:b00c1de48212e4cc9603895652c5c410df699856a2853135b3967591e4beebc2", + "sha256:b1282f8c00509d99fef04d8ba936b156d419be841854fe901d8ae224c59f0be5", + "sha256:b2051432115498d3562c084a49bba65d97cf251f5a331c64a12ee7e04dacc51b", + "sha256:ba59edeaa2fc6114428f1637ffff42da1e311e29382d81b339c1817d37ec93c6", + "sha256:c8716a48d94b06bb3b2524c2b77e055fb313aeb4ea620c8dd03a105574ba704f", + "sha256:cd5df75523866410809ca100dc9681e301e3c27567cf498077e8551b6d20e42f", + "sha256:e249096428b3ae81b08327a63a485ad0878de3fb939049038579ac0ef61e17e7" + ], + "version": "==1.1.1" + }, "mccabe": { "hashes": [ "sha256:ab8a6258860da4b6677da4bd2fe5dc2c659cff31b3ee4f7f5d64e79735b80d42", @@ -317,6 +420,13 @@ "index": "pypi", "version": "==0.4.1" }, + "packaging": { + "hashes": [ + "sha256:0c98a5d0be38ed775798ece1b9727178c4469d9c3b4ada66e8e6b7849f8732af", + "sha256:9e1cbf8c12b1f1ce0bb5344b8d7ecf66a6f8a6e91bcb0c84593ed6d3ab5c4ab3" + ], + "version": "==19.0" + }, "parso": { "hashes": [ "sha256:17cc2d7a945eb42c3569d4564cdf49bde221bc2b552af3eca9c1aad517dcdd33", @@ -375,6 +485,35 @@ ], "version": "==2.3.1" }, + "pyparsing": { + "hashes": [ + "sha256:1873c03321fc118f4e9746baf201ff990ceb915f433f23b395f5580d1840cb2a", + "sha256:9b6323ef4ab914af344ba97510e966d64ba91055d6b9afa6b30799340e89cc03" + ], + "version": "==2.4.0" + }, + "pytz": { + "hashes": [ + "sha256:303879e36b721603cc54604edcac9d20401bdbe31e1e4fdee5b9f98d5d31dfda", + "sha256:d747dd3d23d77ef44c6a3526e274af6efeb0a6f1afd5a69ba4d5be4098c8e141" + ], + "version": "==2019.1" + }, + "recommonmark": { + "hashes": [ + "sha256:a520b8d25071a51ae23a27cf6252f2fe387f51bdc913390d83b2b50617f5bb48", + "sha256:c85228b9b7aea7157662520e74b4e8791c5eacd375332ec68381b52bf10165be" + ], + "index": "pypi", + "version": "==0.5.0" + }, + "requests": { + "hashes": [ + "sha256:502a824f31acdacb3a35b6690b5fbf0bc41d63a24a45c4004352b0242707598e", + "sha256:7bf2a778576d825600030a110f3c0e3e8edc51dfaafe1c146e39a2027784957b" + ], + "version": "==2.21.0" + }, "six": { "hashes": [ "sha256:3350809f0555b11f552448330d0b52d5f24c91a322ea4a15ef22629740f3761c", @@ -382,6 +521,71 @@ ], "version": "==1.12.0" }, + "snowballstemmer": { + "hashes": [ + "sha256:919f26a68b2c17a7634da993d91339e288964f93c274f1343e3bbbe2096e1128", + "sha256:9f3bcd3c401c3e862ec0ebe6d2c069ebc012ce142cce209c098ccb5b09136e89" + ], + "version": "==1.2.1" + }, + "sphinx": { + "hashes": [ + "sha256:423280646fb37944dd3c85c58fb92a20d745793a9f6c511f59da82fa97cd404b", + "sha256:de930f42600a4fef993587633984cc5027dedba2464bcf00ddace26b40f8d9ce" + ], + "index": "pypi", + "version": "==2.0.1" + }, + "sphinx-py3doc-enhanced-theme": { + "hashes": [ + "sha256:0a0dc9b81d047c10f9a44a0f85df409afedc804751924a21c781d323e14aaf18", + "sha256:170ac7aad9c8f61c4400b7ec64d2b944c2158ad328d725818095c42950a3675c" + ], + "index": "pypi", + "version": "==2.4.0" + }, + "sphinxcontrib-applehelp": { + "hashes": [ + "sha256:edaa0ab2b2bc74403149cb0209d6775c96de797dfd5b5e2a71981309efab3897", + "sha256:fb8dee85af95e5c30c91f10e7eb3c8967308518e0f7488a2828ef7bc191d0d5d" + ], + "version": "==1.0.1" + }, + "sphinxcontrib-devhelp": { + "hashes": [ + "sha256:6c64b077937330a9128a4da74586e8c2130262f014689b4b89e2d08ee7294a34", + "sha256:9512ecb00a2b0821a146736b39f7aeb90759834b07e81e8cc23a9c70bacb9981" + ], + "version": "==1.0.1" + }, + "sphinxcontrib-htmlhelp": { + "hashes": [ + "sha256:4670f99f8951bd78cd4ad2ab962f798f5618b17675c35c5ac3b2132a14ea8422", + "sha256:d4fd39a65a625c9df86d7fa8a2d9f3cd8299a3a4b15db63b50aac9e161d8eff7" + ], + "version": "==1.0.2" + }, + "sphinxcontrib-jsmath": { + "hashes": [ + "sha256:2ec2eaebfb78f3f2078e73666b1415417a116cc848b72e5172e596c871103178", + "sha256:a9925e4a4587247ed2191a22df5f6970656cb8ca2bd6284309578f2153e0c4b8" + ], + "version": "==1.0.1" + }, + "sphinxcontrib-qthelp": { + "hashes": [ + "sha256:513049b93031beb1f57d4daea74068a4feb77aa5630f856fcff2e50de14e9a20", + "sha256:79465ce11ae5694ff165becda529a600c754f4bc459778778c7017374d4d406f" + ], + "version": "==1.0.2" + }, + "sphinxcontrib-serializinghtml": { + "hashes": [ + "sha256:c0efb33f8052c04fd7a26c0a07f1678e8512e0faec19f4aa8f2473a8b81d5227", + "sha256:db6615af393650bf1151a6cd39120c29abaf93cc60db8c48eb2dddbfdc3a9768" + ], + "version": "==1.1.3" + }, "traitlets": { "hashes": [ "sha256:9c4bd2d267b7153df9152698efb1050a5d84982d3384a37b2c1f7723ba3e7835", @@ -422,6 +626,13 @@ ], "version": "==3.7.2" }, + "urllib3": { + "hashes": [ + "sha256:4c291ca23bbb55c76518905869ef34bdd5f0e46af7afe6861e8375643ffee1a0", + "sha256:9a247273df709c4fedb38c711e44292304f73f39ab01beda9f6b9fc375669ac3" + ], + "version": "==1.24.2" + }, "wcwidth": { "hashes": [ "sha256:3df37372226d6e63e1b1e1eda15c594bca98a22d33a23832a90998faa96bc65e", diff --git a/archivebox/docs/Makefile b/archivebox/docs/Makefile new file mode 100644 index 00000000..298ea9e2 --- /dev/null +++ b/archivebox/docs/Makefile @@ -0,0 +1,19 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file diff --git a/archivebox/docs/archivebox.cli.rst b/archivebox/docs/archivebox.cli.rst new file mode 100644 index 00000000..b67dd564 --- /dev/null +++ b/archivebox/docs/archivebox.cli.rst @@ -0,0 +1,126 @@ +archivebox.cli package +====================== + +Submodules +---------- + +archivebox.cli.archivebox module +-------------------------------- + +.. automodule:: archivebox.cli.archivebox + :members: + :undoc-members: + :show-inheritance: + +archivebox.cli.archivebox\_add module +------------------------------------- + +.. automodule:: archivebox.cli.archivebox_add + :members: + :undoc-members: + :show-inheritance: + +archivebox.cli.archivebox\_config module +---------------------------------------- + +.. automodule:: archivebox.cli.archivebox_config + :members: + :undoc-members: + :show-inheritance: + +archivebox.cli.archivebox\_help module +-------------------------------------- + +.. automodule:: archivebox.cli.archivebox_help + :members: + :undoc-members: + :show-inheritance: + +archivebox.cli.archivebox\_info module +-------------------------------------- + +.. automodule:: archivebox.cli.archivebox_info + :members: + :undoc-members: + :show-inheritance: + +archivebox.cli.archivebox\_init module +-------------------------------------- + +.. automodule:: archivebox.cli.archivebox_init + :members: + :undoc-members: + :show-inheritance: + +archivebox.cli.archivebox\_list module +-------------------------------------- + +.. automodule:: archivebox.cli.archivebox_list + :members: + :undoc-members: + :show-inheritance: + +archivebox.cli.archivebox\_manage module +---------------------------------------- + +.. automodule:: archivebox.cli.archivebox_manage + :members: + :undoc-members: + :show-inheritance: + +archivebox.cli.archivebox\_remove module +---------------------------------------- + +.. automodule:: archivebox.cli.archivebox_remove + :members: + :undoc-members: + :show-inheritance: + +archivebox.cli.archivebox\_schedule module +------------------------------------------ + +.. automodule:: archivebox.cli.archivebox_schedule + :members: + :undoc-members: + :show-inheritance: + +archivebox.cli.archivebox\_server module +---------------------------------------- + +.. automodule:: archivebox.cli.archivebox_server + :members: + :undoc-members: + :show-inheritance: + +archivebox.cli.archivebox\_shell module +--------------------------------------- + +.. automodule:: archivebox.cli.archivebox_shell + :members: + :undoc-members: + :show-inheritance: + +archivebox.cli.archivebox\_update module +---------------------------------------- + +.. automodule:: archivebox.cli.archivebox_update + :members: + :undoc-members: + :show-inheritance: + +archivebox.cli.archivebox\_version module +----------------------------------------- + +.. automodule:: archivebox.cli.archivebox_version + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: archivebox.cli + :members: + :undoc-members: + :show-inheritance: diff --git a/archivebox/docs/archivebox.core.migrations.rst b/archivebox/docs/archivebox.core.migrations.rst new file mode 100644 index 00000000..72c2291e --- /dev/null +++ b/archivebox/docs/archivebox.core.migrations.rst @@ -0,0 +1,30 @@ +archivebox.core.migrations package +================================== + +Submodules +---------- + +archivebox.core.migrations.0001\_initial module +----------------------------------------------- + +.. automodule:: archivebox.core.migrations.0001_initial + :members: + :undoc-members: + :show-inheritance: + +archivebox.core.migrations.0002\_auto\_20190417\_0739 module +------------------------------------------------------------ + +.. automodule:: archivebox.core.migrations.0002_auto_20190417_0739 + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: archivebox.core.migrations + :members: + :undoc-members: + :show-inheritance: diff --git a/archivebox/docs/archivebox.core.rst b/archivebox/docs/archivebox.core.rst new file mode 100644 index 00000000..8b4682ce --- /dev/null +++ b/archivebox/docs/archivebox.core.rst @@ -0,0 +1,93 @@ +archivebox.core package +======================= + +Subpackages +----------- + +.. toctree:: + + archivebox.core.migrations + +Submodules +---------- + +archivebox.core.admin module +---------------------------- + +.. automodule:: archivebox.core.admin + :members: + :undoc-members: + :show-inheritance: + +archivebox.core.apps module +--------------------------- + +.. automodule:: archivebox.core.apps + :members: + :undoc-members: + :show-inheritance: + +archivebox.core.models module +----------------------------- + +.. automodule:: archivebox.core.models + :members: + :undoc-members: + :show-inheritance: + +archivebox.core.settings module +------------------------------- + +.. automodule:: archivebox.core.settings + :members: + :undoc-members: + :show-inheritance: + +archivebox.core.tests module +---------------------------- + +.. automodule:: archivebox.core.tests + :members: + :undoc-members: + :show-inheritance: + +archivebox.core.urls module +--------------------------- + +.. automodule:: archivebox.core.urls + :members: + :undoc-members: + :show-inheritance: + +archivebox.core.views module +---------------------------- + +.. automodule:: archivebox.core.views + :members: + :undoc-members: + :show-inheritance: + +archivebox.core.welcome\_message module +--------------------------------------- + +.. automodule:: archivebox.core.welcome_message + :members: + :undoc-members: + :show-inheritance: + +archivebox.core.wsgi module +--------------------------- + +.. automodule:: archivebox.core.wsgi + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: archivebox.core + :members: + :undoc-members: + :show-inheritance: diff --git a/archivebox/docs/archivebox.legacy.rst b/archivebox/docs/archivebox.legacy.rst new file mode 100644 index 00000000..d6539674 --- /dev/null +++ b/archivebox/docs/archivebox.legacy.rst @@ -0,0 +1,93 @@ +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: diff --git a/archivebox/docs/archivebox.legacy.storage.rst b/archivebox/docs/archivebox.legacy.storage.rst new file mode 100644 index 00000000..c45d7967 --- /dev/null +++ b/archivebox/docs/archivebox.legacy.storage.rst @@ -0,0 +1,38 @@ +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: diff --git a/archivebox/docs/archivebox.rst b/archivebox/docs/archivebox.rst new file mode 100644 index 00000000..6ce85e0a --- /dev/null +++ b/archivebox/docs/archivebox.rst @@ -0,0 +1,39 @@ +archivebox package +================== + +Subpackages +----------- + +.. toctree:: + + archivebox.cli + archivebox.core + archivebox.legacy + +Submodules +---------- + +archivebox.manage module +------------------------ + +.. automodule:: archivebox.manage + :members: + :undoc-members: + :show-inheritance: + +archivebox.tests module +----------------------- + +.. automodule:: archivebox.tests + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: archivebox + :members: + :undoc-members: + :show-inheritance: diff --git a/archivebox/docs/conf.py b/archivebox/docs/conf.py new file mode 100644 index 00000000..5f70592e --- /dev/null +++ b/archivebox/docs/conf.py @@ -0,0 +1,105 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# http://www.sphinx-doc.org/en/master/config + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +import os +import sys +sys.path.insert(0, os.path.abspath('.')) + +import django +import sphinx_py3doc_enhanced_theme + +sys.path.insert(0, os.path.abspath('../')) +sys.path.insert(0, os.path.abspath('.')) +os.environ.setdefault("DJANGO_SETTINGS_MODULE", "core.settings") +django.setup() + +# -- Project information ----------------------------------------------------- + +project = 'ArchiveBox' +copyright = '2019, Nick Sweeting' +author = 'Nick Sweeting' + +# The full version, including alpha/beta/rc tags +release = 'v0.4.0' + + +# -- General configuration --------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.napoleon', + 'sphinx.ext.viewcode', + # 'sphinxcontrib.blockdiag' + 'recommonmark' +] + +source_suffix = { + '.rst': 'restructuredtext', + '.txt': 'markdown', + '.md': 'markdown', +} +master_doc = 'index' +napoleon_google_docstring = True +napoleon_use_param = True +napoleon_use_ivar = False +napoleon_use_rtype = True +napoleon_include_special_with_doc = False + +# Add any paths that contain templates here, relative to this directory. +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'] + + +# -- Options for HTML output ------------------------------------------------- + +# 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()] + +texinfo_documents = [ + (master_doc, 'archivebox', 'archivebox Documentation', + author, 'archivebox', 'The open-source self-hosted internet archive.', + '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, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + + +man_pages = [ + (master_doc, 'archivebox', 'archivebox Documentation', + [author], 1) +] diff --git a/archivebox/docs/index.rst b/archivebox/docs/index.rst new file mode 100644 index 00000000..ffc8a790 --- /dev/null +++ b/archivebox/docs/index.rst @@ -0,0 +1,27 @@ +.. 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 diff --git a/archivebox/docs/modules.rst b/archivebox/docs/modules.rst new file mode 100644 index 00000000..2ef953f1 --- /dev/null +++ b/archivebox/docs/modules.rst @@ -0,0 +1,7 @@ +archivebox +========== + +.. toctree:: + :maxdepth: 4 + + archivebox