From 6e0588f4cb26548344a33f8530ded631e7e85aaf Mon Sep 17 00:00:00 2001 From: Daniel Schadt Date: Sat, 9 Jul 2022 11:28:32 +0200 Subject: start writing docs properly, not in the README --- doc/index.rst | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 doc/index.rst (limited to 'doc/index.rst') diff --git a/doc/index.rst b/doc/index.rst new file mode 100644 index 0000000..05449cd --- /dev/null +++ b/doc/index.rst @@ -0,0 +1,46 @@ +.. Fietsboek documentation master file, created by + sphinx-quickstart on Thu Jun 30 20:46:28 2022. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Fietsboek's documentation! +===================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + administration/installation + administration/configuration + administration/upgrading + administration/backup + +Fietsboek is a self-hostable sharing site for GPX track recordings with social +features. The goal is to have an application like `MyTourbook +`__ that runs as a web-service +and allows sharing and discovering of new tracks. + +This documentation contains content pertaining to the installation, maintenance +and administration of a Fietsboek setup. Documentation about using Fietsboek +and extending/modifying Fietsboek will follow in the future. + +Fietsboek is `FLOSS +`__, licensed +under the `AGPLv3 license `__. +Fietsboek is built on top of the following open source technologies: + +* `Pyramid `__ +* `gpxpy `__ +* Jürgen Berkemeier's `GPXViewer `__ +* `OpenStreetMap `__ +* `Bootstrap `__ and `Bootstrap Icons + `__ +* `OpenSans `__ (Copyright 2020 The + Open Sans Project Authors) + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` -- cgit v1.2.3