Create 3.0 docs framework

Creates the basic structure of the documentation that will go out with 3.0.0. This also moves all the old docs so that they can be moved as necessary. re #2348 https://pulp.plan.io/issues/2348
pulp · Nov 15, 2016 · 5fe4245 · 5fe4245
1 parent c27ee37
commit 5fe4245
Show file tree

Hide file tree

Showing 188 changed files with 89 additions and 275 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -49,7 +49,7 @@ diagrams:
 	plantuml diagrams_src/*.dot
 	mv diagrams_src/*.png $(DIAGRAM_BUILD_DIR)/
 
-html: diagrams
+html:
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

diff --git a/docs/_extensions/rest_api.py b/docs/_extensions/rest_api.py
diff --git a/docs/cli_guide/index.rst b/docs/cli_guide/index.rst
@@ -0,0 +1,9 @@
+CLI User Guide
+==============
+
+.. toctree::
+   :maxdepth: 2
+
+   installation
+   quickstart
+   reference/index
diff --git a/docs/cli_guide/installation.rst b/docs/cli_guide/installation.rst
@@ -0,0 +1,2 @@
+Installation
+============
diff --git a/docs/cli_guide/quickstart.rst b/docs/cli_guide/quickstart.rst
@@ -0,0 +1,2 @@
+Quickstart
+==========
diff --git a/docs/cli_guide/reference/index.rst b/docs/cli_guide/reference/index.rst
@@ -0,0 +1,4 @@
+CLI Docs
+========
+
+This is where the full CLI reference documentation will live.
diff --git a/docs/conf.py b/docs/conf.py
@@ -18,8 +18,7 @@
 # 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.
-#sys.path.insert(0, os.path.abspath('.'))
-sys.path.insert(0, os.path.abspath('./_extensions'))
+sys.path.insert(0, os.path.abspath('./extensions'))
 
 # -- General configuration -----------------------------------------------------
 
@@ -28,7 +27,7 @@
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['rest_api', 'sphinx.ext.extlinks', 'sphinx.ext.autodoc', 'sphinx.ext.autosummary',
+extensions = ['sphinx.ext.extlinks', 'sphinx.ext.autodoc', 'sphinx.ext.autosummary',
               'napoleon_django', 'sphinx.ext.napoleon']
 
 # Add any paths that contain templates here, relative to this directory.
@@ -132,7 +131,7 @@
 # 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']
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.

diff --git a/...v-guide/3.0-development/data-modeling.rst → ...ibuting/3.0-development/data-modeling.rst b/...v-guide/3.0-development/data-modeling.rst → ...ibuting/3.0-development/data-modeling.rst
diff --git a/.../3.0-development/db-translation-guide.rst → .../3.0-development/db-translation-guide.rst b/.../3.0-development/db-translation-guide.rst → .../3.0-development/db-translation-guide.rst
diff --git a/docs/dev-guide/3.0-development/index.rst → docs/contributing/3.0-development/index.rst b/docs/dev-guide/3.0-development/index.rst → docs/contributing/3.0-development/index.rst
@@ -21,6 +21,4 @@ The goal of this section is to create a place for living documents related to th
 
    data-modeling
    db-translation-guide
-   dev-setup
-   plugin-api
    rest-api
diff --git a/docs/dev-guide/3.0-development/rest-api.rst → ...contributing/3.0-development/rest-api.rst b/docs/dev-guide/3.0-development/rest-api.rst → ...contributing/3.0-development/rest-api.rst
diff --git a/docs/contributing/build_guide.rst b/docs/contributing/build_guide.rst
@@ -0,0 +1,2 @@
+Build Guide
+===========
diff --git a/docs/contributing/dev-setup.rst b/docs/contributing/dev-setup.rst
@@ -0,0 +1,2 @@
+Developer Setup
+===============
diff --git a/docs/contributing/git.rst b/docs/contributing/git.rst
@@ -0,0 +1,2 @@
+Git
+===
diff --git a/docs/contributing/index.rst b/docs/contributing/index.rst
@@ -0,0 +1,13 @@
+Contributing Guide
+==================
+
+.. toctree::
+   :maxdepth: 2
+
+   3.0-development/index
+   dev-setup
+   plugin_api/index
+   git
+   new_contributors
+   style_guide
+   build_guide
diff --git a/docs/contributing/new_contributors.rst b/docs/contributing/new_contributors.rst
@@ -0,0 +1,2 @@
+New Contributors
+================
diff --git a/docs/contributing/plugin_api/index.rst b/docs/contributing/plugin_api/index.rst
@@ -0,0 +1,2 @@
+Plugin API
+==========
diff --git a/docs/contributing/style_guide.rst b/docs/contributing/style_guide.rst
@@ -0,0 +1,2 @@
+Style Guide
+===========
diff --git a/docs/dev-guide/3.0-development/dev-setup.rst b/docs/dev-guide/3.0-development/dev-setup.rst
diff --git a/docs/dev-guide/3.0-development/plugin-api.rst b/docs/dev-guide/3.0-development/plugin-api.rst
diff --git a/docs/_extensions/napoleon_django/__init__.py → docs/extensions/napoleon_django/__init__.py b/docs/_extensions/napoleon_django/__init__.py → docs/extensions/napoleon_django/__init__.py
diff --git a/.../_extensions/napoleon_django/docstring.py → docs/extensions/napoleon_django/docstring.py b/.../_extensions/napoleon_django/docstring.py → docs/extensions/napoleon_django/docstring.py
diff --git a/docs/getting_help/bug_filing.rst b/docs/getting_help/bug_filing.rst
@@ -0,0 +1,2 @@
+Bug Filing Guide
+================
diff --git a/docs/getting_help/index.rst b/docs/getting_help/index.rst
@@ -0,0 +1,4 @@
+.. toctree::
+   :maxdepth: 2
+
+   bug_filing 
diff --git a/docs/glossary.rst b/docs/glossary.rst
@@ -0,0 +1,2 @@
+Glossary
+========
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,21 +1,11 @@
-.. _pulp_documentation:
-
 Pulp Documentation
-==================
 
 .. toctree::
    :maxdepth: 2
 
-   user-guide/index
-   dev-guide/index
-   dev-guide/contributing/bugs
-   dev-guide/contributing/features
-   api/pulp/app/index
-   api/pulp/plugin
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`search`
+   cli_guide/index
+   integration_guide/index
+   contributing/index
+   release_notes/index
+   getting_help/index
+   glossary
diff --git a/docs/integration_guide/index.rst b/docs/integration_guide/index.rst
@@ -0,0 +1,4 @@
+.. toctree::
+   :maxdepth: 2
+
+   rest_api/index
diff --git a/docs/integration_guide/rest_api/index.rst b/docs/integration_guide/rest_api/index.rst
@@ -0,0 +1,2 @@
+REST API Reference
+==================