Merge pull request #3 from dcermak/add-docs

Scaffold simple documentation

README.rst

@@ -0,0 +1,8 @@
+RPM Spec File Language Server
+=============================
+
+Requirements
+------------
+
+- Python >= 3.11
+- `poetry <https://python-poetry.org/>`_

source/conf.py

@@ -0,0 +1,26 @@
+# 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 = "RPM Spec Language Server"
+copyright = "2023, Dan Čermák, Matěj Čepl, Jehan Singh"
+author = "Dan Čermák, Matěj Čepl, Jehan Singh"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = []
+
+templates_path = ["_templates"]
+exclude_patterns = []
+
+
+# -- 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"]

source/index.rst

@@ -0,0 +1,19 @@
+.. RPM Spec Language Server7 documentation master file, created by
+   sphinx-quickstart on Sun Nov  5 21:06:14 2023.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+.. include:: ../README.rst
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`