From fa15dd04269189d1980e388d3a3a91850b78dbc3 Mon Sep 17 00:00:00 2001 From: Elena ``of Valhalla'' Grandi Date: Fri, 2 Oct 2020 09:40:14 +0200 Subject: Use the README as the front page of the docs --- docs/source/index.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 292a0ce..fa199e5 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -3,8 +3,7 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to lesana's documentation! -================================== +.. include:: ../../README.rst .. toctree:: :maxdepth: 2 -- cgit v1.2.3 From 7b619bcd24b91ae58112554c84581f571caee48b Mon Sep 17 00:00:00 2001 From: Elena ``of Valhalla'' Grandi Date: Fri, 2 Oct 2020 09:40:57 +0200 Subject: Updated README to 2020 --- README.rst | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 366446b..7bf8cf4 100644 --- a/README.rst +++ b/README.rst @@ -39,9 +39,6 @@ Under debian (and derivatives), the packages to install are:: apt install python3-jinja2 python3-ruamel.yaml python3-xapian python3-git -(some of those are only available on stretch+ because earlier -versions lacked python3 support.) - lesana can be run in place from the git checkout / extracted tarball; to use ``setup.py`` you will also need setuptools (e.g. from the ``python3-setuptools`` package under debian and derivatives). @@ -49,7 +46,7 @@ use ``setup.py`` you will also need setuptools (e.g. from the License ------- -Copyright (C) 2016-2019 Elena Grandi +Copyright (C) 2016-2020 Elena Grandi This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by -- cgit v1.2.3 From 25f62632daa1830b6811c10f83222d0009ff322d Mon Sep 17 00:00:00 2001 From: Elena ``of Valhalla'' Grandi Date: Fri, 2 Oct 2020 09:49:26 +0200 Subject: Pointers to the online docs --- docs/source/index.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/source/index.rst b/docs/source/index.rst index fa199e5..c041709 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -5,6 +5,17 @@ .. include:: ../../README.rst +Documentation +------------- + +The documentation for the latest development version of lesana can be +browsed online at https://lesana.trueelena.org; `PDF +`_ and `epub +`_ versions are also +available. + + + .. toctree:: :maxdepth: 2 :caption: Contents: -- cgit v1.2.3 From ea27af383f0099111bce5801db52d173430f0401 Mon Sep 17 00:00:00 2001 From: Elena ``of Valhalla'' Grandi Date: Fri, 2 Oct 2020 09:53:29 +0200 Subject: References to the git repository and email contact --- README.rst | 4 ++++ docs/source/index.rst | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 7bf8cf4..8bcc251 100644 --- a/README.rst +++ b/README.rst @@ -25,6 +25,10 @@ by simply writing a personalized ``settings.yaml``. Installation ------------ +The source code for lesana can be downloaded from the git repository at +https://git.trueelena.org/cgit.cgi/software/lesana/; releases are made +on `pypi `_. + lesana expects to run on a POSIX-like system and requires the following dependencies: diff --git a/docs/source/index.rst b/docs/source/index.rst index c041709..fe3c821 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -14,7 +14,7 @@ browsed online at https://lesana.trueelena.org; `PDF `_ versions are also available. - +The author can be contacted via email: webmaster AT trueelena DOT org. .. toctree:: :maxdepth: 2 -- cgit v1.2.3 From 50e4015c1c251cdf5a49257ab9f6a2f4ff909cc1 Mon Sep 17 00:00:00 2001 From: Elena ``of Valhalla'' Grandi Date: Fri, 2 Oct 2020 09:55:11 +0200 Subject: Ignore generated files --- .gitignore | 2 ++ docs/.gitignore | 1 + 2 files changed, 3 insertions(+) create mode 100644 docs/.gitignore diff --git a/.gitignore b/.gitignore index 004a8d7..8534f9c 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,4 @@ *.pyc .coverage + +.*.sw? diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..378eac2 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +build -- cgit v1.2.3