diff options
| author | Jake Hunsaker <jhunsake@redhat.com> | 2020-08-20 13:45:28 -0400 |
|---|---|---|
| committer | Jake Hunsaker <jhunsake@redhat.com> | 2020-08-26 12:47:34 -0400 |
| commit | 88dc5f9d0af635a95fcda366299d3e40d00a0680 (patch) | |
| tree | 923dfb24e972b24e7975c5427d1706a86c827bbb | |
| parent | 52f4661e2b594134b98e2967b02cc860d7963fef (diff) | |
| download | sos-88dc5f9d0af635a95fcda366299d3e40d00a0680.tar.gz | |
[docs] Small fixes for RTD online generation changes
A few changes on the RTD side in turn need us to slightly adjust some
parts of our docs in-tree so that RTD can successfully build the docs
online based on current master branch.
Resolves: #2209
Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
| -rw-r--r-- | README.md | 4 | ||||
| -rw-r--r-- | docs/clusters.rst | 4 | ||||
| -rw-r--r-- | docs/index.rst | 16 | ||||
| -rw-r--r-- | docs/parsers.rst | 4 |
4 files changed, 9 insertions, 19 deletions
@@ -1,4 +1,4 @@ -[](https://travis-ci.org/sosreport/sos) [](https://lgtm.com/projects/g/sosreport/sos/context:python) +[](https://travis-ci.org/sosreport/sos) [](https://sos.readthedocs.io/en/master/?badge=master) [](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: |