Browse Source

Update documentation

Remove unused code only content from documentation:
* Installation document
* Usage document
* Search in code modules
* Search for functions

Change-Id: I7c6c492a1efe9d078e4233ace986989de7941e88
Andreas Jaeger 2 years ago
parent
commit
722329b18f
3 changed files with 1 additions and 29 deletions
  1. 1
    10
      doc/source/index.rst
  2. 0
    12
      doc/source/installation.rst
  3. 0
    7
      doc/source/usage.rst

+ 1
- 10
doc/source/index.rst View File

@@ -1,10 +1,5 @@
1
-.. openstack-ux documentation master file, created by
2
-   sphinx-quickstart on Tue Jul  9 22:26:36 2013.
3
-   You can adapt this file completely to your liking, but it should at least
4
-   contain the root `toctree` directive.
5
-
6 1
 Welcome to openstack-ux's documentation!
7
-========================================================
2
+========================================
8 3
 
9 4
 Contents:
10 5
 
@@ -12,14 +7,10 @@ Contents:
12 7
    :maxdepth: 2
13 8
 
14 9
    readme
15
-   installation
16
-   usage
17 10
    contributing
18 11
 
19 12
 Indices and tables
20 13
 ==================
21 14
 
22
-* :ref:`genindex`
23
-* :ref:`modindex`
24 15
 * :ref:`search`
25 16
 

+ 0
- 12
doc/source/installation.rst View File

@@ -1,12 +0,0 @@
1
-============
2
-Installation
3
-============
4
-
5
-At the command line::
6
-
7
-    $ pip install openstack-ux
8
-
9
-Or, if you have virtualenvwrapper installed::
10
-
11
-    $ mkvirtualenv openstack-ux
12
-    $ pip install openstack-ux

+ 0
- 7
doc/source/usage.rst View File

@@ -1,7 +0,0 @@
1
-========
2
-Usage
3
-========
4
-
5
-To use openstack-ux in a project::
6
-
7
-    import foo

Loading…
Cancel
Save