summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAkihiro Motoki <amotoki@gmail.com>2017-07-01 20:21:47 +0900
committerAkihiro Motoki <amotoki@gmail.com>2017-07-01 21:05:49 +0900
commit0f3ea232b750deff33a6106c37a169891872ee93 (patch)
tree291f8e4f476c2707969c6b79326531d624284a6e
parentd14dfdf5c4eca410d3da165611d21142828fb560 (diff)
downloadoslo-utils-0f3ea232b750deff33a6106c37a169891872ee93.tar.gz
rearrange existing documentation to fit the new standard layout3.27.0
Change-Id: I0727caae202b385d740b006fd957b990e308c6d7
-rw-r--r--doc/source/contributing.rst5
-rw-r--r--doc/source/contributor/index.rst5
-rw-r--r--doc/source/history.rst1
-rw-r--r--doc/source/index.rst49
-rw-r--r--doc/source/install/index.rst (renamed from doc/source/installation.rst)0
-rw-r--r--doc/source/reference/dictutils.rst (renamed from doc/source/api/dictutils.rst)0
-rw-r--r--doc/source/reference/encodeutils.rst (renamed from doc/source/api/encodeutils.rst)0
-rw-r--r--doc/source/reference/eventletutils.rst (renamed from doc/source/api/eventletutils.rst)0
-rw-r--r--doc/source/reference/excutils.rst (renamed from doc/source/api/excutils.rst)0
-rw-r--r--doc/source/reference/fileutils.rst (renamed from doc/source/api/fileutils.rst)0
-rw-r--r--doc/source/reference/fixture.rst (renamed from doc/source/api/fixture.rst)0
-rw-r--r--doc/source/reference/importutils.rst (renamed from doc/source/api/importutils.rst)0
-rw-r--r--doc/source/reference/index.rst23
-rw-r--r--doc/source/reference/netutils.rst (renamed from doc/source/api/netutils.rst)0
-rw-r--r--doc/source/reference/reflection.rst (renamed from doc/source/api/reflection.rst)0
-rw-r--r--doc/source/reference/secretutils.rst (renamed from doc/source/api/secretutils.rst)0
-rw-r--r--doc/source/reference/specs_matcher.rst (renamed from doc/source/api/specs_matcher.rst)0
-rw-r--r--doc/source/reference/strutils.rst (renamed from doc/source/api/strutils.rst)0
-rw-r--r--doc/source/reference/timeutils.rst (renamed from doc/source/api/timeutils.rst)0
-rw-r--r--doc/source/reference/units.rst (renamed from doc/source/api/units.rst)0
-rw-r--r--doc/source/reference/uuidutils.rst (renamed from doc/source/api/uuidutils.rst)0
-rw-r--r--doc/source/reference/versionutils.rst (renamed from doc/source/api/versionutils.rst)0
-rw-r--r--doc/source/user/history.rst1
-rw-r--r--doc/source/user/index.rst15
-rw-r--r--doc/source/user/timeutils.rst (renamed from doc/source/examples/timeutils.rst)0
-rw-r--r--doc/source/user/usage.rst (renamed from doc/source/usage.rst)0
26 files changed, 49 insertions, 50 deletions
diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst
deleted file mode 100644
index 2ca75d1..0000000
--- a/doc/source/contributing.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-==============
- Contributing
-==============
-
-.. include:: ../../CONTRIBUTING.rst
diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst
new file mode 100644
index 0000000..3d4ceb4
--- /dev/null
+++ b/doc/source/contributor/index.rst
@@ -0,0 +1,5 @@
+============
+Contributing
+============
+
+.. include:: ../../../CONTRIBUTING.rst
diff --git a/doc/source/history.rst b/doc/source/history.rst
deleted file mode 100644
index 69ed4fe..0000000
--- a/doc/source/history.rst
+++ /dev/null
@@ -1 +0,0 @@
-.. include:: ../../ChangeLog
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 9b445c4..9cd2faf 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -8,51 +8,12 @@ such as encoding, exception handling, string manipulation, and time handling.
.. toctree::
:maxdepth: 1
- installation
- usage
- contributing
+ install/index
+ user/index
+ reference/index
+ contributor/index
-API Documentation
-=================
-
-.. toctree::
- :maxdepth: 2
-
- api/dictutils
- api/encodeutils
- api/eventletutils
- api/excutils
- api/fileutils
- api/fixture
- api/importutils
- api/netutils
- api/reflection
- api/secretutils
- api/specs_matcher
- api/strutils
- api/timeutils
- api/units
- api/uuidutils
- api/versionutils
-
-Examples
-========
-
-.. toctree::
- :maxdepth: 2
-
- examples/timeutils
-
-Release Notes
-=============
-
-.. toctree::
- :maxdepth: 1
-
- history
-
-Indices and tables
-==================
+.. rubric:: Indices and tables
* :ref:`genindex`
* :ref:`modindex`
diff --git a/doc/source/installation.rst b/doc/source/install/index.rst
index 688d549..688d549 100644
--- a/doc/source/installation.rst
+++ b/doc/source/install/index.rst
diff --git a/doc/source/api/dictutils.rst b/doc/source/reference/dictutils.rst
index 00fb39d..00fb39d 100644
--- a/doc/source/api/dictutils.rst
+++ b/doc/source/reference/dictutils.rst
diff --git a/doc/source/api/encodeutils.rst b/doc/source/reference/encodeutils.rst
index 35f339c..35f339c 100644
--- a/doc/source/api/encodeutils.rst
+++ b/doc/source/reference/encodeutils.rst
diff --git a/doc/source/api/eventletutils.rst b/doc/source/reference/eventletutils.rst
index 5e7a39a..5e7a39a 100644
--- a/doc/source/api/eventletutils.rst
+++ b/doc/source/reference/eventletutils.rst
diff --git a/doc/source/api/excutils.rst b/doc/source/reference/excutils.rst
index f5a67a0..f5a67a0 100644
--- a/doc/source/api/excutils.rst
+++ b/doc/source/reference/excutils.rst
diff --git a/doc/source/api/fileutils.rst b/doc/source/reference/fileutils.rst
index 575bedf..575bedf 100644
--- a/doc/source/api/fileutils.rst
+++ b/doc/source/reference/fileutils.rst
diff --git a/doc/source/api/fixture.rst b/doc/source/reference/fixture.rst
index d8205ed..d8205ed 100644
--- a/doc/source/api/fixture.rst
+++ b/doc/source/reference/fixture.rst
diff --git a/doc/source/api/importutils.rst b/doc/source/reference/importutils.rst
index a8f7558..a8f7558 100644
--- a/doc/source/api/importutils.rst
+++ b/doc/source/reference/importutils.rst
diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst
new file mode 100644
index 0000000..1fcbb1e
--- /dev/null
+++ b/doc/source/reference/index.rst
@@ -0,0 +1,23 @@
+=============
+API Reference
+=============
+
+.. toctree::
+ :maxdepth: 2
+
+ dictutils
+ encodeutils
+ eventletutils
+ excutils
+ fileutils
+ fixture
+ importutils
+ netutils
+ reflection
+ secretutils
+ specs_matcher
+ strutils
+ timeutils
+ units
+ uuidutils
+ versionutils
diff --git a/doc/source/api/netutils.rst b/doc/source/reference/netutils.rst
index 0fa3156..0fa3156 100644
--- a/doc/source/api/netutils.rst
+++ b/doc/source/reference/netutils.rst
diff --git a/doc/source/api/reflection.rst b/doc/source/reference/reflection.rst
index fc11d2b..fc11d2b 100644
--- a/doc/source/api/reflection.rst
+++ b/doc/source/reference/reflection.rst
diff --git a/doc/source/api/secretutils.rst b/doc/source/reference/secretutils.rst
index 3e9f943..3e9f943 100644
--- a/doc/source/api/secretutils.rst
+++ b/doc/source/reference/secretutils.rst
diff --git a/doc/source/api/specs_matcher.rst b/doc/source/reference/specs_matcher.rst
index 216eefd..216eefd 100644
--- a/doc/source/api/specs_matcher.rst
+++ b/doc/source/reference/specs_matcher.rst
diff --git a/doc/source/api/strutils.rst b/doc/source/reference/strutils.rst
index fe8dabf..fe8dabf 100644
--- a/doc/source/api/strutils.rst
+++ b/doc/source/reference/strutils.rst
diff --git a/doc/source/api/timeutils.rst b/doc/source/reference/timeutils.rst
index 0b5c72b..0b5c72b 100644
--- a/doc/source/api/timeutils.rst
+++ b/doc/source/reference/timeutils.rst
diff --git a/doc/source/api/units.rst b/doc/source/reference/units.rst
index 5a09d3b..5a09d3b 100644
--- a/doc/source/api/units.rst
+++ b/doc/source/reference/units.rst
diff --git a/doc/source/api/uuidutils.rst b/doc/source/reference/uuidutils.rst
index f1d03e9..f1d03e9 100644
--- a/doc/source/api/uuidutils.rst
+++ b/doc/source/reference/uuidutils.rst
diff --git a/doc/source/api/versionutils.rst b/doc/source/reference/versionutils.rst
index f75e726..f75e726 100644
--- a/doc/source/api/versionutils.rst
+++ b/doc/source/reference/versionutils.rst
diff --git a/doc/source/user/history.rst b/doc/source/user/history.rst
new file mode 100644
index 0000000..f69be70
--- /dev/null
+++ b/doc/source/user/history.rst
@@ -0,0 +1 @@
+.. include:: ../../../ChangeLog
diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst
new file mode 100644
index 0000000..c31b8e4
--- /dev/null
+++ b/doc/source/user/index.rst
@@ -0,0 +1,15 @@
+==================
+Using oslo.service
+==================
+
+.. toctree::
+ :maxdepth: 2
+
+ usage
+ timeutils
+
+.. history contains a lot of sections, toctree with maxdepth 1 is used.
+.. toctree::
+ :maxdepth: 1
+
+ history
diff --git a/doc/source/examples/timeutils.rst b/doc/source/user/timeutils.rst
index eeecb50..eeecb50 100644
--- a/doc/source/examples/timeutils.rst
+++ b/doc/source/user/timeutils.rst
diff --git a/doc/source/usage.rst b/doc/source/user/usage.rst
index 88ee1ad..88ee1ad 100644
--- a/doc/source/usage.rst
+++ b/doc/source/user/usage.rst