aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md4
-rw-r--r--docs/clusters.rst4
-rw-r--r--docs/index.rst16
-rw-r--r--docs/parsers.rst4
4 files changed, 9 insertions, 19 deletions
diff --git a/README.md b/README.md
index e63e3af6..bc081806 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.org/sosreport/sos.svg?branch=master)](https://travis-ci.org/sosreport/sos) [![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/sosreport/sos.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/sosreport/sos/context:python)
+[![Build Status](https://travis-ci.org/sosreport/sos.svg?branch=master)](https://travis-ci.org/sosreport/sos) [![Documentation Status](https://readthedocs.org/projects/sos/badge/?version=master)](https://sos.readthedocs.io/en/master/?badge=master) [![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/sosreport/sos.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/sosreport/sos/context:python)
# SoS
@@ -116,6 +116,6 @@ sudo apt install sosreport
[3]: https://github.com/sosreport/sos/wiki/Plugin-options
[4]: https://www.redhat.com/mailman/listinfo/sos-devel
[5]: https://github.com/sosreport/sos/issues?state=open
- [6]: https://sos.readthedocs.org/en/latest/index.html
+ [6]: https://sos.readthedocs.org/
[7]: https://www.sphinx-doc.org/
[8]: https://www.readthedocs.org/
diff --git a/docs/clusters.rst b/docs/clusters.rst
index 109c2cd7..5a0c34cb 100644
--- a/docs/clusters.rst
+++ b/docs/clusters.rst
@@ -1,5 +1,5 @@
-``sos.collector.clusters`` --- Cluster Profiles
-================================================
+``sos.collector.clusters`` --- Cluster Interface
+=================================================
.. automodule:: sos.collector.clusters
:noindex:
diff --git a/docs/index.rst b/docs/index.rst
index b86832c6..bb4904b6 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -58,9 +58,7 @@ Manual Installation
.. code::
- to install locally (as root) ==> make install
- to build an rpm ==> make rpm
- to build a deb ==> make deb
+ python3 setup.py install
Pre-built Packaging
^^^^^^^^^^^^^^^^^^^
@@ -80,16 +78,6 @@ Ubuntu (14.04 LTS and above) users install via apt:
API
===
-Plugin Reference
-^^^^^^^^^^^^^^^^
-
-.. toctree::
- :maxdepth: 2
-
- plugins
- clusters
- parsers
-
Core Reference
^^^^^^^^^^^^^^
@@ -97,6 +85,8 @@ Core Reference
:maxdepth: 4
archive
+ clusters
+ parsers
policies
plugins
reporting
diff --git a/docs/parsers.rst b/docs/parsers.rst
index 7b15ca25..c747a186 100644
--- a/docs/parsers.rst
+++ b/docs/parsers.rst
@@ -1,5 +1,5 @@
-``sos.cleaner.parsers`` --- Cleaning Parser Definition
-=======================================================
+``sos.cleaner.parsers`` --- Parser Interface
+=============================================
.. automodule:: sos.cleaner.parsers
:noindex: