From f073d361fe6a5e0354f7ba17979d4b8768405931 Mon Sep 17 00:00:00 2001 From: Imran Iqbal Date: Thu, 28 Feb 2019 16:21:27 +0000 Subject: [PATCH] docs(index): use include for `README.rst` in `docs` and test RTD --- README.rst | 98 +------------------------------------------------ docs/README.rst | 98 +++++++++++++++++++++++++++++++++++++++++++++++++ docs/index.rst | 25 +++++++++++++ 3 files changed, 124 insertions(+), 97 deletions(-) create mode 100644 docs/README.rst create mode 100644 docs/index.rst diff --git a/README.rst b/README.rst index 744bffbf..b8210919 100644 --- a/README.rst +++ b/README.rst @@ -1,98 +1,2 @@ -================ -template-formula -================ - -|img_travis| |img_sr| - -.. |img_travis| image:: https://travis-ci.com/saltstack-formulas/template-formula.svg?branch=master - :target: https://travis-ci.com/saltstack-formulas/template-formula -.. |img_sr| image:: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg - :target: https://github.com/semantic-release/semantic-release - -A SaltStack formula that is empty. It has dummy content to help with a quick -start on a new formula and it serves as a style guide. - -.. contents:: **Table of Contents** - -General notes -============= - -See the full `SaltStack Formulas installation and usage instructions -`_. - -If you are interested in writing or contributing to formulas, please pay attention to the `Writing Formula Section -`_. - -If you want to use this formula, please pay attention to the ``FORMULA`` file and/or ``git tag``, -which contains the currently released version. This formula is versioned according to `Semantic Versioning `_. - -See `Formula Versioning Section `_ for more details. - - -Contributing to this repo -========================= - -**Commit message formatting is significant!!** - -Please see `CONTRIBUTING `_ for more details. - - -Available states -================ - -.. contents:: - :local: - -``template`` ------------- - -Meta-state (This is a state that includes other states) - -This installs the template package, -manages the template configuration file and then -starts the associated template service. - -``template.package`` --------------------- - -This state will install the template package only. - -``template.config`` -------------------- - -This state will configure the template service and has a dependency on ``template.install`` -via include list. - -``template.service`` --------------------- - -This state will start the template service and has a dependency on ``template.config`` -via include list. - -``template.clean`` ------------------- - -Meta-state (This is a state that includes other states) - -this state will undo everything performed in the ``template`` meta-state in reverse order, i.e. -stops the service, -removes the configuration file and -then uninstalls the package. - -``template.service.clean`` --------------------------- - -This state will stop the template service and disable it at boot time. - -``template.config.clean`` -------------------------- - -This state will remove the configuration of the template service and has a dependency on ``template.service.clean`` -via include list. - -``template.package.clean`` --------------------------- - -This state will remove the template package and has a depency on ``template.config.clean`` -via include list. +.. include:: docs/README.rst diff --git a/docs/README.rst b/docs/README.rst new file mode 100644 index 00000000..744bffbf --- /dev/null +++ b/docs/README.rst @@ -0,0 +1,98 @@ +================ +template-formula +================ + +|img_travis| |img_sr| + +.. |img_travis| image:: https://travis-ci.com/saltstack-formulas/template-formula.svg?branch=master + :target: https://travis-ci.com/saltstack-formulas/template-formula +.. |img_sr| image:: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg + :target: https://github.com/semantic-release/semantic-release + +A SaltStack formula that is empty. It has dummy content to help with a quick +start on a new formula and it serves as a style guide. + +.. contents:: **Table of Contents** + +General notes +============= + +See the full `SaltStack Formulas installation and usage instructions +`_. + +If you are interested in writing or contributing to formulas, please pay attention to the `Writing Formula Section +`_. + +If you want to use this formula, please pay attention to the ``FORMULA`` file and/or ``git tag``, +which contains the currently released version. This formula is versioned according to `Semantic Versioning `_. + +See `Formula Versioning Section `_ for more details. + + +Contributing to this repo +========================= + +**Commit message formatting is significant!!** + +Please see `CONTRIBUTING `_ for more details. + + +Available states +================ + +.. contents:: + :local: + +``template`` +------------ + +Meta-state (This is a state that includes other states) + +This installs the template package, +manages the template configuration file and then +starts the associated template service. + +``template.package`` +-------------------- + +This state will install the template package only. + +``template.config`` +------------------- + +This state will configure the template service and has a dependency on ``template.install`` +via include list. + +``template.service`` +-------------------- + +This state will start the template service and has a dependency on ``template.config`` +via include list. + +``template.clean`` +------------------ + +Meta-state (This is a state that includes other states) + +this state will undo everything performed in the ``template`` meta-state in reverse order, i.e. +stops the service, +removes the configuration file and +then uninstalls the package. + +``template.service.clean`` +-------------------------- + +This state will stop the template service and disable it at boot time. + +``template.config.clean`` +------------------------- + +This state will remove the configuration of the template service and has a dependency on ``template.service.clean`` +via include list. + +``template.package.clean`` +-------------------------- + +This state will remove the template package and has a depency on ``template.config.clean`` +via include list. + diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000..bebbaf03 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,25 @@ +.. ``template-formula`` documentation master file. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to ``template-formula``'s documentation! +================================================ + +.. toctree:: + :maxdepth: 2 + :caption: Contents + + README + + + +.. :numbered: +.. :glob: +.. :titlesonly: +.. :hidden: +.. Indices and tables +.. ================== +.. +.. * :ref:`genindex` +.. .. * :ref:`modindex` +.. * :ref:`search`