https://github.com/divio/divio-cloud-docs

Divio Cloud documentation for developers
https://github.com/divio/divio-cloud-docs

Last synced: 3 months ago
JSON representation

Divio Cloud documentation for developers

• Host: GitHub
• URL: https://github.com/divio/divio-cloud-docs
• Owner: divio
• Archived: true
• Created: 2017-06-21T16:05:01.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-07-20T09:32:50.000Z (over 2 years ago)
• Last Synced: 2024-04-03T15:32:48.062Z (7 months ago)
• Language: Python
• Homepage: http://docs.divio.com/
• Size: 7.77 MB
• Stars: 12
• Watchers: 9
• Forks: 23
• Open Issues: 4
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst

Awesome Lists containing this project

README

        
Divio Documentation

===================

.. image:: https://readthedocs.com/projects/divio-divio-cloud-docs/badge/?version=latest

    :target: https://docs.divio.com/en/latest/?badge=latest

    :alt: Documentation status

.. image:: https://github.com/divio/divio-cloud-docs/actions/workflows/default.yml/badge.svg

    :target: https://github.com/divio/divio-cloud-docs/actions/workflows/default.yml

    :alt: GitHub workflow status

The official documentation for Divio and its products.

Build the documentation locally

-------------------------------

You'll need the `enchant `_

library, used by ``pyenchant`` for spelling.

Install with ``brew install enchant`` (macOS) or the appropriate command for

your system.

Then::

    git clone [email protected]:divio/divio-cloud-docs.git

    cd divio-cloud-docs

    make install

    make run

    open http://localhost:9001

Notable techniques used in this documentation

---------------------------------------------

* We serve our documentation via `Read the Docs `_.

* The documentation is written in ReStructed Text (RST) and built using 

  `Sphinx `_.

* `Intersphinx `_

  to reference to other documentation.

Documentation structure and standards

-------------------------------------

Our documentation structure is key to its usability. See our 

`What nobody tells you about documentation `_ 

system for an explanation of why it's important and how it works.

See also our `additional documentation standards 

`_.