summaryrefslogtreecommitdiff
path: root/docs/rtd/source
diff options
context:
space:
mode:
authorbaude <bbaude@redhat.com>2019-10-22 15:23:54 -0500
committerbaude <bbaude@redhat.com>2019-10-22 15:28:32 -0500
commitaac33a4a30a596a395f043b5762c88ccccc571a5 (patch)
tree61c140c8943642091e3bec5acb59e06b35a1e00d /docs/rtd/source
parentd358840ebe02f45ef782546fc3f8369ff2870ea5 (diff)
downloadpodman-aac33a4a30a596a395f043b5762c88ccccc571a5.tar.gz
podman-aac33a4a30a596a395f043b5762c88ccccc571a5.tar.bz2
podman-aac33a4a30a596a395f043b5762c88ccccc571a5.zip
Initial checking for readthedocs
Signed-off-by: baude <bbaude@redhat.com>
Diffstat (limited to 'docs/rtd/source')
-rw-r--r--docs/rtd/source/conf.py56
-rw-r--r--docs/rtd/source/index.rst20
2 files changed, 76 insertions, 0 deletions
diff --git a/docs/rtd/source/conf.py b/docs/rtd/source/conf.py
new file mode 100644
index 000000000..9290c343a
--- /dev/null
+++ b/docs/rtd/source/conf.py
@@ -0,0 +1,56 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'Podman'
+copyright = '2019, team'
+author = 'team'
+
+
+# -- 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 = [
+ 'recommonmark',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+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 = []
+
+
+# -- 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 = 'alabaster'
+
+# 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']
+
+
+# -- Extension configuration -------------------------------------------------
diff --git a/docs/rtd/source/index.rst b/docs/rtd/source/index.rst
new file mode 100644
index 000000000..90033056c
--- /dev/null
+++ b/docs/rtd/source/index.rst
@@ -0,0 +1,20 @@
+.. Podman documentation master file, created by
+ sphinx-quickstart on Tue Oct 22 15:20:30 2019.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to Podman's documentation!
+==================================
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`