https://github.com/debops/docs

DebOps documentation
https://github.com/debops/docs

Last synced: about 1 year ago
JSON representation

DebOps documentation

• Host: GitHub
• URL: https://github.com/debops/docs
• Owner: debops
• License: mit
• Created: 2014-12-05T21:56:06.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2021-07-11T11:37:51.000Z (almost 5 years ago)
• Last Synced: 2025-06-08T07:11:28.842Z (about 1 year ago)
• Language: Shell
• Size: 988 KB
• Stars: 28
• Watchers: 7
• Forks: 21
• Open Issues: 26
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
`DebOps documentation`_

~~~~~~~~~~~~~~~~~~~~~~~

|Travis CI| |ReadTheDocs|

.. |Travis CI| image:: https://img.shields.io/travis/debops/docs.svg?style=flat

   :target: https://travis-ci.org/debops/docs

.. |ReadTheDocs| image:: https://readthedocs.org/projects/debops/badge/?version=latest

   :target: https://readthedocs.org/projects/debops/?badge=latest

This is the repository for the `DebOps`_ documentation.

It uses Sphinx_, yaml2rst_ and a bit of glue code.

The documentation is currently build on `Read The Docs`_.

The canonical URL of the documentation is: https://docs.debops.org/

Manual edits can be done as well. Either directly in DebOps `git repository`_ or accessible via each page of the DebOps documentation_; click upper right corner *Edit on GitHub*. The syntax used by DebOps documentation is ReStructuredText_, a `lightweight markup language`_. A quick syntax reference including *Plain text vs Typical result* comparison can be found here_.

.. _DebOps documentation: https://docs.debops.org/

.. _DebOps: https://debops.org/

.. _Sphinx: https://en.wikipedia.org/wiki/Sphinx_%28documentation_generator%29

.. _yaml2rst: https://github.com/htgoebel/yaml2rst

.. _Read The Docs: https://readthedocs.org/projects/debops/

.. _git repository: https://github.com/debops

.. _documentation: https://docs.debops.org/

.. _ReStructuredText: https://en.wikipedia.org/wiki/ReStructuredText

.. _lightweight markup language : https://en.wikipedia.org/wiki/Lightweight_markup_language

.. _here: http://docutils.sourceforge.net/docs/user/rst/quickref.html