Merge remote-tracking branch 'gitea/docs'

README.rst

@@ -0,0 +1,27 @@
+.. Can we write README's in ReST also for use on Gitea? Let's see :-)
+
+Birdvisu
+@@@@@@@@
+
+Birdvisu is a library and a graphical app to visualize routing topologies of
+OSPF. It does not implement OSPF on its own, but rather exports current state
+from `BIRD`_ – that's where the name comes from.
+
+Also, this is the project for my Bachelor thesis.
+
+.. TODO: link the thesis, when it is done.
+
+.. _BIRD: https://bird.network.cz/
+
+Documentation
+=============
+
+Documentation is built using `Sphinx`_ by running ``make`` in the ``docs/`` directory.
+
+.. _Sphinx: https://www.sphinx-doc.org/
+
+Licence
+=======
+
+I have not decided yet, so please ask for terms if you want to use this in some
+non-trivial way. Obviously this is source available :-)

docs/.gitignore

@@ -0,0 +1 @@
+/_build

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -0,0 +1,27 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'Birdvisu'
+copyright = '2022, Pavel Turinský'
+author = 'Pavel Turinský'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ['sphinx.ext.autodoc']
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'alabaster'
+html_static_path = ['_static']

docs/index.rst

@@ -0,0 +1,22 @@
+.. Birdvisu documentation master file, created by
+   sphinx-quickstart on Tue Nov 22 19:48:56 2022.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Birdvisu's documentation!
+====================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   intro
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/intro.rst

@@ -0,0 +1,9 @@
+Introduction
+@@@@@@@@@@@@
+
+Birdvisu is a library and a graphical app to visualize routing topologies of
+OSPF. It does not implement OSPF on its own, but rather exports current state
+from `BIRD`_ – that's where the name comes from.
+
+
+.. _BIRD: https://bird.network.cz