From 29d91a79e623e4cff17546b30a3196deaf51dbd0 Mon Sep 17 00:00:00 2001 From: Elena ``of Valhalla'' Grandi Date: Thu, 1 Oct 2020 22:38:56 +0200 Subject: Skeleton of sphinx documentation --- docs/source/conf.py | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) create mode 100644 docs/source/conf.py (limited to 'docs/source/conf.py') diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 0000000..df9c092 --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,59 @@ +# 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: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- 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 = 'lesana' +copyright = "2020, Elena Grandi" +author = "Elena ``of Valhalla''" + +# The short version +version = '0.6' +# The full version, including alpha/beta/rc tags +release = '0.6.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.viewcode', +] + +# 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 = [] + + +# -- 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' + +# 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'] -- cgit v1.2.3 From 92fdc8343afaafea0e705078ed7f0933cf475715 Mon Sep 17 00:00:00 2001 From: Elena ``of Valhalla'' Grandi Date: Thu, 1 Oct 2020 23:08:53 +0200 Subject: Fix building on buster --- docs/source/conf.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'docs/source/conf.py') diff --git a/docs/source/conf.py b/docs/source/conf.py index df9c092..37e0e4c 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -21,11 +21,13 @@ project = 'lesana' copyright = "2020, Elena Grandi" author = "Elena ``of Valhalla''" -# The short version -version = '0.6' # The full version, including alpha/beta/rc tags release = '0.6.0' +# The major project version +version = '0.6' +# compatibility with sphinx 1.8 on buster +master_doc = 'index' # -- General configuration --------------------------------------------------- -- cgit v1.2.3 From e3e1aac99ff15ef99ac6d3fd8539492a2c4801be Mon Sep 17 00:00:00 2001 From: Elena ``of Valhalla'' Grandi Date: Thu, 1 Oct 2020 23:27:30 +0200 Subject: Start building manpages with sphinx --- docs/man/Makefile | 12 ------- docs/man/lesana-edit.rst | 35 ------------------ docs/man/lesana-export.rst | 32 ----------------- docs/man/lesana-index.rst | 30 ---------------- docs/man/lesana-init.rst | 40 --------------------- docs/man/lesana-new.rst | 37 ------------------- docs/man/lesana-rm.rst | 30 ---------------- docs/man/lesana-search.rst | 37 ------------------- docs/man/lesana-show.rst | 45 ----------------------- docs/man/lesana.rst | 76 --------------------------------------- docs/source/conf.py | 12 +++++++ docs/source/index.rst | 2 ++ docs/source/man/Makefile | 12 +++++++ docs/source/man/index.rst | 17 +++++++++ docs/source/man/lesana-edit.rst | 35 ++++++++++++++++++ docs/source/man/lesana-export.rst | 32 +++++++++++++++++ docs/source/man/lesana-index.rst | 30 ++++++++++++++++ docs/source/man/lesana-init.rst | 40 +++++++++++++++++++++ docs/source/man/lesana-new.rst | 37 +++++++++++++++++++ docs/source/man/lesana-rm.rst | 30 ++++++++++++++++ docs/source/man/lesana-search.rst | 37 +++++++++++++++++++ docs/source/man/lesana-show.rst | 45 +++++++++++++++++++++++ docs/source/man/lesana.rst | 76 +++++++++++++++++++++++++++++++++++++++ 23 files changed, 405 insertions(+), 374 deletions(-) delete mode 100644 docs/man/Makefile delete mode 100644 docs/man/lesana-edit.rst delete mode 100644 docs/man/lesana-export.rst delete mode 100644 docs/man/lesana-index.rst delete mode 100644 docs/man/lesana-init.rst delete mode 100644 docs/man/lesana-new.rst delete mode 100644 docs/man/lesana-rm.rst delete mode 100644 docs/man/lesana-search.rst delete mode 100644 docs/man/lesana-show.rst delete mode 100644 docs/man/lesana.rst create mode 100644 docs/source/man/Makefile create mode 100644 docs/source/man/index.rst create mode 100644 docs/source/man/lesana-edit.rst create mode 100644 docs/source/man/lesana-export.rst create mode 100644 docs/source/man/lesana-index.rst create mode 100644 docs/source/man/lesana-init.rst create mode 100644 docs/source/man/lesana-new.rst create mode 100644 docs/source/man/lesana-rm.rst create mode 100644 docs/source/man/lesana-search.rst create mode 100644 docs/source/man/lesana-show.rst create mode 100644 docs/source/man/lesana.rst (limited to 'docs/source/conf.py') diff --git a/docs/man/Makefile b/docs/man/Makefile deleted file mode 100644 index 0369f59..0000000 --- a/docs/man/Makefile +++ /dev/null @@ -1,12 +0,0 @@ - -MAN_TARGETS = $(patsubst %.rst,%.1,$(wildcard *.rst)) - -all: $(MAN_TARGETS) - -%.1: %.rst - rst2man $< > $@ - -clean: - rm *.1 - -.PHONY: all clean diff --git a/docs/man/lesana-edit.rst b/docs/man/lesana-edit.rst deleted file mode 100644 index 75bcaeb..0000000 --- a/docs/man/lesana-edit.rst +++ /dev/null @@ -1,35 +0,0 @@ -=========== -lesana-edit -=========== - ------------------------------- -edits an existing lesana entry ------------------------------- - -:Author: valhalla@trueelena.org -:Manual section: 1 - -SYNOPSIS -======== - -lesana edit [--help] [--collection ] [--no-git] - -DESCRIPTION -=========== - -Lesana edit will open an existing entry (specified by id or partial id) -in an editor, so that it can be changed. - -If the collection is configured to use git, after the editor has been -closed, it will add the file to the git staging area, unless -``--no-git`` is given. - -OPTIONS -======= - --h, --help - Prints an help message and exits. ---collection COLLECTION, -c COLLECTION - The collection to work on. Default is ``.`` ---no-git - Don't add the new entry to git. diff --git a/docs/man/lesana-export.rst b/docs/man/lesana-export.rst deleted file mode 100644 index 6088dbf..0000000 --- a/docs/man/lesana-export.rst +++ /dev/null @@ -1,32 +0,0 @@ -============= -lesana-export -============= - -------------------------------------------------- -export data from one lesana collection to another -------------------------------------------------- - -:Author: valhalla@trueelena.org -:Manual section: 1 - -SYNOPSIS -======== - -lesana export [-h] [--collection COLLECTION] [--query QUERY] destination template - -DESCRIPTION -=========== - -Lesana export converts entries from one lesana collection to another, -using a jinja2 template. - -OPTIONS -======= - --h, --help - Prints an help message and exits. ---collection COLLECTION, -c COLLECTION - The collection to work on. Default is ``.`` ---query QUERY, -q QUERY - Xapian query to search in the collection - diff --git a/docs/man/lesana-index.rst b/docs/man/lesana-index.rst deleted file mode 100644 index d535c02..0000000 --- a/docs/man/lesana-index.rst +++ /dev/null @@ -1,30 +0,0 @@ -============ -lesana-index -============ - ------------------- -Index some entries ------------------- - -:Author: valhalla@trueelena.org -:Manual section: 1 - -SYNOPSIS -======== - -lesana index [--help] [--collection COLLECTION] [files [files ...]] - -DESCRIPTION -=========== - -Lesana index adds some entries to the xapian cache, listed by filename -(by default all of the files found in the items directory). - -OPTIONS -======= - --h, --help - Prints an help message and exits. ---collection COLLECTION, -c COLLECTION - The collection to work on. Default is ``.`` - diff --git a/docs/man/lesana-init.rst b/docs/man/lesana-init.rst deleted file mode 100644 index 92527c0..0000000 --- a/docs/man/lesana-init.rst +++ /dev/null @@ -1,40 +0,0 @@ -=========== -lesana-init -=========== - ------------------------------- -initialize a lesana collection ------------------------------- - -:Author: valhalla@trueelena.org -:Manual section: 1 - -SYNOPSIS -======== - -lesana init [--help] [--collection ] [--no-git] - -DESCRIPTION -=========== - -lesana init initializes a new lesana collection. - -It will create the directory (if it does not exist) and, unless -``--no-git`` is specified it will initialize it as a git repository and -create a ``.gitignore`` file with some relevant contents. - -It will then create a skeleton ``settings.yaml`` file and open it in an -editor to start configuring the collection. - -When leaving the editor, again unless ``--no-git`` is used, it will add -this file to the git staging area, but not commit it. - -OPTIONS -======= - ---help, -h - Prints an help message and exits. ---collection COLLECTION, -c COLLECTION - The directory where the collection will be initialized. Default is . ---no-git - Do not use git in the current collection. diff --git a/docs/man/lesana-new.rst b/docs/man/lesana-new.rst deleted file mode 100644 index 4c7a10d..0000000 --- a/docs/man/lesana-new.rst +++ /dev/null @@ -1,37 +0,0 @@ -========== -lesana-new -========== - -------------------------- -create a new lesana entry -------------------------- - -:Author: valhalla@trueelena.org -:Manual section: 1 - -SYNOPSIS -======== - -lesana new [--help] [--collection ] [--no-git] - -DESCRIPTION -=========== - -Lesana new creates a new lesana entry. - -It will create an empty entry and open an editor so that it can be -filled. - -If the collection is configured to use git, after the editor has been -closed, it will add the file to the git staging area, unless -``--no-git`` is given. - -OPTIONS -======= - --h, --help - Prints an help message and exits. ---collection COLLECTION, -c COLLECTION - The collection to work on. Default is ``.`` ---no-git - Don't add the new entry to git. diff --git a/docs/man/lesana-rm.rst b/docs/man/lesana-rm.rst deleted file mode 100644 index 4f765a5..0000000 --- a/docs/man/lesana-rm.rst +++ /dev/null @@ -1,30 +0,0 @@ -========= -lesana-rm -========= - ----------------------------------------- -remove an entry from a lesana collection ----------------------------------------- - -:Author: valhalla@trueelena.org -:Manual section: 1 - -SYNOPSIS -======== - -lesana rm [-h] [--collection COLLECTION] entries [entries ...] - -DESCRIPTION -=========== - -Lesana rm removes an entry from the collection, removing both the file -and the cached entry. - -OPTIONS -======= - --h, --help - Prints an help message and exits. ---collection COLLECTION, -c COLLECTION - The collection to work on. Default is ``.`` - diff --git a/docs/man/lesana-search.rst b/docs/man/lesana-search.rst deleted file mode 100644 index 9375541..0000000 --- a/docs/man/lesana-search.rst +++ /dev/null @@ -1,37 +0,0 @@ -============= -lesana-search -============= - ---------------------------------- -search inside a lesana collection ---------------------------------- - -:Author: valhalla@trueelena.org -:Manual section: 1 - -SYNOPSIS -======== - -lesana search [--help] [--collection COLLECTION] [--template TEMPLATE] \ -[--offset OFFSET] [--pagesize PAGESIZE] [--all] query [query ...] - -DESCRIPTION -=========== - - -OPTIONS -======= - --h, --help - Prints an help message and exits. ---collection COLLECTION, -c COLLECTION - The collection to work on. Default is ``.`` ---template TEMPLATE, -t TEMPLATE - Template to use when displaying results ---offset OFFSET - . ---pagesize PAGESIZE - . ---all - Return all available results - diff --git a/docs/man/lesana-show.rst b/docs/man/lesana-show.rst deleted file mode 100644 index 516f9de..0000000 --- a/docs/man/lesana-show.rst +++ /dev/null @@ -1,45 +0,0 @@ -=========== -lesana-show -=========== - -------------------- -show a lesana entry -------------------- - -:Author: valhalla@trueelena.org -:Manual section: 1 - -SYNOPSIS -======== - -lesana show [--help] [--collection COLLECTION] [--template TEMPLATE] - -DESCRIPTION -=========== - -``lesana show`` will print an entry (specified by id or partial id) to -stdout. - -A template can be specified with ``--template