summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLars-Dominik Braun <lars@6xq.net>2019-07-28 15:39:37 +0200
committerLars-Dominik Braun <lars@6xq.net>2019-07-28 15:39:37 +0200
commit5ef4c9450e05ab28adb0f94f4f373af599fce6f4 (patch)
tree71edd893809f44a1f0f59d9cc81bbd9043b8288b /doc
parenta3d927fa0b25f48197ee3f00b12992e9b0bf9665 (diff)
downloadcrocoite-5ef4c9450e05ab28adb0f94f4f373af599fce6f4.tar.gz
crocoite-5ef4c9450e05ab28adb0f94f4f373af599fce6f4.tar.bz2
crocoite-5ef4c9450e05ab28adb0f94f4f373af599fce6f4.zip
Update docs
Add missing optin -b for IRC bot. Simplify sphinx config file.
Diffstat (limited to 'doc')
-rw-r--r--doc/conf.py157
-rw-r--r--doc/usage.rst2
2 files changed, 6 insertions, 153 deletions
diff --git a/doc/conf.py b/doc/conf.py
index 9dbeabe..26747b4 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -1,43 +1,13 @@
# -*- coding: utf-8 -*-
-#
-# Configuration file for the Sphinx documentation builder.
-#
-# This file does only contain 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('.'))
-
# -- Project information -----------------------------------------------------
project = 'crocoite'
-copyright = ''
-author = ''
-
-# The short X.Y version
-version = ''
-# The full version, including alpha/beta/rc tags
-release = '0.1'
-
+copyright = '2019 crocoite contributors'
+author = 'crocoite contributors'
# -- General configuration ---------------------------------------------------
-# If your documentation needs a minimal Sphinx version, state it here.
-#
-# needs_sphinx = '1.0'
-
-# 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.viewcode',
'sphinx.ext.autodoc',
@@ -46,42 +16,15 @@ extensions = [
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
-# The suffix(es) of source filenames.
-# You can specify multiple suffix as a list of string:
-#
-# source_suffix = ['.rst', '.md']
source_suffix = '.rst'
-
-# The master toctree document.
master_doc = 'index'
-
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#
-# This is also used if you do content translation via gettext catalogs.
-# Usually you set "language" from the command line for these cases.
-language = None
-
-# 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.
+language = 'en'
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
-
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = None
-
+pygments_style = 'tango'
# -- 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 = 'alabaster'
-
-# Theme options are theme-specific and customize the look and feel of a theme
-# further. For a list of options available for each theme, see the
-# documentation.
-#
html_theme_options = {
"description": "Preservation for the modern web",
"github_user": "PromyLOPh",
@@ -91,98 +34,8 @@ html_theme_options = {
"codecov_button": True,
"fixed_sidebar": True,
}
-
-# 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']
-
-# Custom sidebar templates, must be a dictionary that maps document names
-# to template names.
-#
-# The default sidebars (for documents that don't match any pattern) are
-# defined by theme itself. Builtin themes are using these templates by
-# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
-# 'searchbox.html']``.
-#
+#html_static_path = ['_static']
html_sidebars = {
'**': ['about.html', 'navigation.html', 'searchbox.html'],
}
-
-# -- Options for HTMLHelp output ---------------------------------------------
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = 'crocoitedoc'
-
-
-# -- Options for LaTeX output ------------------------------------------------
-
-latex_elements = {
- # The paper size ('letterpaper' or 'a4paper').
- #
- # 'papersize': 'letterpaper',
-
- # The font size ('10pt', '11pt' or '12pt').
- #
- # 'pointsize': '10pt',
-
- # Additional stuff for the LaTeX preamble.
- #
- # 'preamble': '',
-
- # Latex figure (float) alignment
- #
- # 'figure_align': 'htbp',
-}
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title,
-# author, documentclass [howto, manual, or own class]).
-latex_documents = [
- (master_doc, 'crocoite.tex', 'crocoite Documentation',
- 'crocoite contributors', 'manual'),
-]
-
-
-# -- Options for manual page output ------------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-man_pages = [
- (master_doc, 'crocoite', 'crocoite Documentation',
- [author], 1)
-]
-
-
-# -- Options for Texinfo output ----------------------------------------------
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-# dir menu entry, description, category)
-texinfo_documents = [
- (master_doc, 'crocoite', 'crocoite Documentation',
- author, 'crocoite', 'One line description of project.',
- 'Miscellaneous'),
-]
-
-
-# -- Options for Epub output -------------------------------------------------
-
-# Bibliographic Dublin Core info.
-epub_title = project
-
-# The unique identifier of the text. This can be a ISBN number
-# or the project homepage.
-#
-# epub_identifier = ''
-
-# A unique identification for the text.
-#
-# epub_uid = ''
-
-# A list of files that should not be packed into the epub file.
-epub_exclude_files = ['search.html']
-
-
-# -- Extension configuration -------------------------------------------------
diff --git a/doc/usage.rst b/doc/usage.rst
index c18f9fb..34a3e7b 100644
--- a/doc/usage.rst
+++ b/doc/usage.rst
@@ -154,7 +154,7 @@ A simple IRC bot (“chromebot”) is provided with the command :program:`crocoi
It reads its configuration from a config file like the example provided in
:file:`contrib/chromebot.json` and supports the following commands:
-a <url> -j <concurrency> -r <policy> -k
+a <url> -j <concurrency> -r <policy> -k -b <set-cookie>
Archive <url> with <concurrency> processes according to recursion <policy>
s <uuid>
Get job status for <uuid>