aboutsummaryrefslogtreecommitdiffstats
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* [docs] Small fixes for RTD online generation changesJake Hunsaker2020-08-263-17/+7
| | | | | | | | | | 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>
* [build] Bump version to 4.04.0Jake Hunsaker2020-08-171-2/+2
| | | | | | This commits marks the release of sos-4.0 Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [docs|cleaner] Update parser docstring to Sphinx styleJake Hunsaker2020-08-171-1/+0
| | | | | | | | | Updates the docstring style for `SoSCleanerParser` to Sphinx style as part of the effort to update our Sphinx documentation Related: #2172 Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [docs|clusters] Update docstrings to use Sphinx style formattingJake Hunsaker2020-08-171-1/+0
| | | | | | | | | Updates the docstrings for `Cluster()` to use SPhinx-style formatting as part of the effort to bring our Sphinx docs up to date. Related: #2172 Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [docs|policy] Update Policy to sphinx-style docstringsJake Hunsaker2020-08-171-1/+0
| | | | | | | | | Updates the `Policy` and related docstrings to Sphinx-style as part of the work to bring the API docs up to date. Related: #2172 Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [docs|plugin] Standardize docstrings on Sphinx styleJake Hunsaker2020-08-171-1/+0
| | | | | | | | | | Standardizes the docstrings within `Plugin()` to adhere to Sphinx-style annotation, to assist with the effort to improve auto documentation generation from Sphinx. Related: #2172 Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [docs] Update sphinx doc generationJake Hunsaker2020-08-176-10/+28
| | | | | | | | | | | | | | Updates the sphinx configuration for 4.0 and extends the generated docs to cover parsers and clusters. Updates the location of plugins to the new structure. Updates setup.py to include sphinx build configuration, as we are no longer using make. Closes: #1991 Resolves: #2172 Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [build] Remove Makefiles from treeJake Hunsaker2020-07-271-310/+0
| | | | | | | | | | Removes all Makefiles from the tree, as of 4.0 the supported method of packaging is via setuptools. Related: #2160 Signed-off-by: Jake Hunsaker <jhunsake@redhat.com> Signed-off-by: Bryan Quigley <code@bryanquigley.com>
* [doc] update documentation URLs to use HTTPSMikel Olasagasti Uranga2019-10-142-7/+7
| | | | | | | Related: #1829 Signed-off-by: Mikel Olasagasti Uranga <mikel@olasagasti.info> Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [docs]: Cleaned minor errors while generating docsSachin Patil2016-04-252-2/+2
| | | | | | | | * Implemented proper code snippet in docstring * Removed '_static/' from html_static_path as it was not used and hence throwing error Signed-off-by: Sachin Patil <sacpatil@redhat.com>
* [docs] Add missing target installFlavio Leitner2015-07-031-1/+134
| | | | | | | | | Updates the docs/Makefile to install all the doc files built. Resolves #585. Signed-off-by: Flavio Leitner <fbl@redhat.com> Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [docs] update version in Sphinx configurationBryn M. Reeves2015-03-021-2/+2
| | | | Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [docs] Add prominent link to user focused docsncoghlan2014-11-101-0/+4
| | | | | It wasn't immediately clear to me from the developer docs what SoS actually *does*, but the user docs made it clear.
* [docs] fix policy section headingsBryn M. Reeves2014-08-071-3/+3
| | | | Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [docs] add policies api referenceAdam Stokes2014-08-072-0/+9
| | | | | | | Include the base policy plugin reference in the auto-generated documentation. Signed-off-by: Adam Stokes <adam.stokes@ubuntu.com>
* [docs] sync README.md and index.rstBryn M. Reeves2014-08-031-4/+12
| | | | Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [docs] improve index formattingBryn M. Reeves2014-08-031-1/+2
| | | | Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [docs] link the mailing list in restructured text properlyAdam Stokes2014-08-011-1/+1
| | | | Signed-off-by: Adam Stokes <adam.stokes@ubuntu.com>
* [docs] fix a typo in the mailing list descriptionBryn M. Reeves2014-08-011-1/+1
| | | | Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [docs] include sos import path for resolving modulesAdam Stokes2014-08-011-0/+3
| | | | | | | During documentation generation we need to be able to resolve the modules on other systems while generating the documentation. Signed-off-by: Adam Stokes <adam.stokes@ubuntu.com>
* [docs] - Add links to wiki documentationAdam Stokes2014-08-011-3/+3
| | | | Signed-off-by: Adam Stokes <adam.stokes@ubuntu.com>
* [docs] - Add API documentation generationAdam Stokes2014-08-017-0/+559
| | | | | | | Use sphinx to generate api docs which we can tie into a service like Read the docs in order to have reference documentation on our apis. Signed-off-by: Adam Stokes <adam.stokes@ubuntu.com>
* build updatesastokes2010-03-264-416/+0
| | | | git-svn-id: svn+ssh://svn.fedorahosted.org/svn/sos/trunk@870 ef72aa8b-4018-0410-8976-d6e080ef94d8
* - moved 1.9 to trunkr1.9astokes2010-02-174-0/+416
git-svn-id: svn+ssh://svn.fedorahosted.org/svn/sos/trunk@778 ef72aa8b-4018-0410-8976-d6e080ef94d8
generated by cgit (git 2.34.1) at 2024-09-21 23:04:17 +0000