diff options
| author | Elena ``of Valhalla'' Grandi <valhalla@trueelena.org> | 2020-10-01 23:04:58 +0200 |
|---|---|---|
| committer | Elena ``of Valhalla'' Grandi <valhalla@trueelena.org> | 2020-10-01 23:04:58 +0200 |
| commit | 8453c268f55ef7cfbc2fe6a6bc5c8ca7a67c8880 (patch) | |
| tree | 2d4e0a4da734ee86cc546a92c383578ff59c8a3e | |
| parent | d120ee47de7d3c02a8420e3a615c6269f88def9c (diff) | |
Moved misc docs to sphinx
| -rw-r--r-- | docs/source/getting_started_command_line.rst (renamed from docs/getting_started_command_line.rst) | 3 | ||||
| -rw-r--r-- | docs/source/index.rst | 4 | ||||
| -rw-r--r-- | docs/source/moving_data_between_collections.rst (renamed from docs/moving_data_between_collections.rst) | 3 | ||||
| -rw-r--r-- | docs/source/promises.rst (renamed from docs/promises.rst) | 9 |
4 files changed, 13 insertions, 6 deletions
diff --git a/docs/getting_started_command_line.rst b/docs/source/getting_started_command_line.rst index d2e4378..0c4d507 100644 --- a/docs/getting_started_command_line.rst +++ b/docs/source/getting_started_command_line.rst @@ -1,5 +1,6 @@ +****************************** Getting Started (Command Line) -============================== +****************************** lesana can be used from the command line through the ``lesana`` command; for more details run ``lesana help``. diff --git a/docs/source/index.rst b/docs/source/index.rst index fbc0ce9..27352ca 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -10,6 +10,10 @@ Welcome to lesana's documentation! :maxdepth: 2 :caption: Contents: + getting_started_command_line + moving_data_between_collections + promises + reference/modules diff --git a/docs/moving_data_between_collections.rst b/docs/source/moving_data_between_collections.rst index 170b391..23c693e 100644 --- a/docs/moving_data_between_collections.rst +++ b/docs/source/moving_data_between_collections.rst @@ -1,5 +1,6 @@ +******************************* Moving Data between Collections -=============================== +******************************* Entries can be exported from a lesana collection to another using the ``lesana export`` command and a jinja2 template. diff --git a/docs/promises.rst b/docs/source/promises.rst index 92ab5aa..6a3b04e 100644 --- a/docs/promises.rst +++ b/docs/source/promises.rst @@ -1,15 +1,16 @@ +******** Promises -======== +******** Semantic versioning -------------------- +=================== This project uses semver_. .. _semver: http://semver.org/ Collection format stability ---------------------------- +=========================== Future versions of lesana will be able to read collections written by older versions. @@ -23,7 +24,7 @@ possibile, and will have enought test data to keep them maintained for the time being. Disposable cache ----------------- +================ Contrary to the yaml files, the xapian cache is considered disposable: from time to time there may be a need to delete the cache and reindex |