Commit 1b19989a authored by aviau's avatar aviau Committed by Guillaume Roguez

Refactor documentation into sections

- Refactored documentation into sections for better viewing experience.

- Allows sub-project to include documentation in the master documentation by
  creating a doc/sphinx folder.

Tuleap: #769
Change-Id: I5c31dd0f2d949b9da602cd0d35751e18e51d6710
parent 11ac3492
../../../daemon/doc/sphinx
\ No newline at end of file
../../../client-gnome/doc/sphinx
\ No newline at end of file
../../../lrc/doc/sphinx
\ No newline at end of file
Getting Started
===============
For now, this manual only covers developers documentation. To get started with Ring, you should visit the `download page <https://ring.cx/en/download>`_ where there are instructions for installing Ring on your system.
Welcome to Ring's documentation!
================================
Contents:
As a new user, :ref:`getting started <getting_started>` is a good place to
start.
As a developer looking to get started with a contribution, see
:ref:`contributing <contributing>` and :ref:`how to build <building>`.
.. toctree::
:caption: Introduction
:maxdepth: 1
:glob:
intro/getting_started
.. toctree::
:caption: User Documentation
:maxdepth: 1
:glob:
users/connecting_to_ldap
users/setting_up_turn_stun
.. toctree::
:caption: Developpers Documentation
:maxdepth: 1
:glob:
dev/contributing
dev/compiling_and_installing/index
dev/releasing
.. toctree::
:caption: Ring Daemon
:maxdepth: 1
:glob:
dev/daemon/*
.. toctree::
:caption: LibRingClient
:maxdepth: 1
:glob:
dev/lrc/*
.. toctree::
:maxdepth: 2
:caption: Gnome Client
:maxdepth: 1
:glob:
getting_started
contributing
compiling_and_installing/index
releasing
setting_up_turn_stun
connecting_to_ldap
dev/gnome-client/*
.. _getting_started:
Getting Started
===============
To get started with Ring, you can install it from our repositories.
Instructions on installing Ring can be found on the
`download section <https://ring.cx/en/download>`_ of the Ring website.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment