diff options
| author |   Juan Antonio Osorio Robles <juan.osorio.robles@ericsson.com> | 2015-06-23 14:37:38 +0300 |
|---|---|---|
| committer | Juan Antonio Osorio Robles <juan.osorio.robles@ericsson.com> | 2015-06-23 14:47:28 +0300 |
| commit | d25c8fe6f331cca1945fe68b40465a0644fe4ee6 (patch) | |
| tree | 00e0a89f3edae3fd84a9541925be26cce33c1b78 /docs/source/index.rst | |
| parent | c7f431c71af18668f2d1af49c274034ef7ade751 (diff) | |
Add Basic repo structure based on Sphinx
This is the initial proposal for the repo structure using Sphinx as a
tool to generate documentation.
The documentation that we will be writing will be in the docs/source
directory.
A requirements.txt was added to make the replication of the environment
needed to build this easier.
NOTE: the following files were automatically generated by the Sphnix
tool:
* docs/Makefile
* docs/source/conf.py
* docs/soruce.index.rst
Change-Id: I6ccd57a6e1a274bb396999ce272678fb9da6f702
Signed-off-by: Juan Antonio Osorio Robles <juan.osorio.robles@ericsson.com>
Diffstat (limited to 'docs/source/index.rst')
| -rw-r--r-- | docs/source/index.rst | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..df0429a --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,22 @@ +.. Inspector documentation master file, created by + sphinx-quickstart on Mon Jun 15 13:40:01 2015. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Inspector's documentation! +===================================== + +Contents: + +.. toctree:: + :maxdepth: 2 + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + |