Merge pull request #125 from aiven/mlatief-init-docs

docs: bootstrap docs

README.rst

@@ -5,7 +5,7 @@ providing functionality for compression, encryption and transferring
 data between the database and an object storage. Rohmu supports main
 public clouds such as GCP, AWS and Azure for backup storage. Rohmu is
 used in various backup tools such as
-`PGHhoard <https://github.com/aiven/pghoard>`__ for PostgreSQL,
+`PGHoard <https://github.com/aiven/pghoard>`__ for PostgreSQL,
 `MyHoard <https://github.com/aiven/myhoard>`__ for MySQL and
 `Astacus <https://github.com/aiven/astacus>`__ for M3 and ClickHouse and
 other databases.

docs/about.rst

@@ -4,4 +4,9 @@ About Rohmu
 Features
 --------
 
-* TODO
+*  Supported object storages: Azure, GCP, S3, Swift (OpenStack), local
+   file storage and SFTP.
+*  Supported compression algorithms: Snappy,
+   `zstd <https://github.com/facebook/zstd>`__ and
+   `lzma <https://docs.python.org/3/library/lzma.html>`__.
+

conf.py → docs/conf.py

@@ -12,46 +12,44 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath('..'))
-from version import get_project_version
+from rohmu.version import VERSION
+
+sys.path.insert(0, os.path.abspath(".."))
 
 
 # -- Project information -----------------------------------------------------
 
-project = 'PGHoard'
-copyright = '2021, Aiven'
-author = 'Aiven'
+project = "Rohmu"
+copyright = "2022, Aiven"
+author = "Aiven"
 
 # The full version, including alpha/beta/rc tags
-release = get_project_version('pghoard/version.py')
+release = VERSION
 
 # -- General configuration ---------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = [
-    "sphinx_rtd_theme"
-]
+extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon", "sphinx_rtd_theme"]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'sphinx_rtd_theme'
+html_theme = "sphinx_rtd_theme"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
-
+# html_static_path = ["_static"]

docs/development.rst

@@ -0,0 +1,23 @@
+Development
+============
+
+Requirements
+------------
+
+Rohmu requires Python >= 3.8. For Python library dependencies, have a
+look at
+`requirements.txt <https://github.com/aiven/rohmu/blob/main/requirements.txt>`__.
+
+
+Building the package
+--------------------
+
+To build an installation package for your distribution, go to the root
+directory of a Rohmu Git checkout and run:
+
+Fedora::
+
+  sudo make fedora-dev-setup
+  make rpm
+
+This will produce a ``.rpm`` package usually into ``rpm/RPMS/noarch/``.

docs/index.rst

@@ -1,11 +1,72 @@
 Rohmu
 =======
 
+|BuildStatus|
+
+.. |BuildStatus| image:: https://github.com/aiven/rohmu/actions/workflows/build.yml/badge.svg?branch=main
+      :target: https://github.com/aiven/rohmu/actions
+      :alt: Build Status
+
+``Rohmu`` is a Python library for building backup tools for databases
+providing functionality for compression, encryption and transferring
+data between the database and an object storage. Rohmu supports main
+public clouds such as GCP, AWS and Azure for backup storage. Rohmu is
+used in various backup tools such as
+`PGHoard <https://github.com/aiven/pghoard>`__ for PostgreSQL,
+`MyHoard <https://github.com/aiven/myhoard>`__ for MySQL and
+`Astacus <https://github.com/aiven/astacus>`__ for M3, ClickHouse and
+other databases.
+
 
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
+   :caption: Contents
+   :glob:
+   :hidden:
 
    about
+   usage
+   development
+
+License
+=======
+
+Rohmu is licensed under the Apache license, version 2.0. Full license
+text is available in the `LICENSE <LICENSE>`__ file.
+
+Please note that the project explicitly does not require a CLA
+(Contributor License Agreement) from its contributors.
+
+Trademarks
+==========
+
+PostgreSQL, MySQL, M3 and ClickHouse are trademarks and property of
+their respective owners. All product and service names used in this
+website are for identification purposes only and do not imply
+endorsement.
+
+Credits
+=======
+
+Rohmu was created by and is maintained by `Aiven
+<https://aiven.io>`__.
+
+Rohmu was originally a part of `PGHoard
+<https://github.com/aiven/pghoard>`__ but was later extracted to its
+own GitHub project.
+
+The Rohmu logo was created by `@evche-aiven
+<https://github.com/evche-aiven>`__.
+
+Contact
+=======
+
+Bug reports and patches are very welcome, please post them as GitHub
+issues and pull requests at https://github.com/aiven/rohmu . To report
+any possible vulnerabilities or other serious issues please see our
+`security <SECURITY.md>`__ policy.
 
+Copyright
+=========
 
+Copyright (C) 2022 Aiven Ltd and contributors to the Rohmu project.

docs/usage.rst

@@ -0,0 +1,5 @@
+Usage example
+=============
+
+For real-world usage you can have a look at `how Rohmu is used in
+PGHoard <https://github.com/aiven/pghoard/blob/main/pghoard/basebackup.py>`__.