diff --git a/docs/source/compiling_and_installing/daemon.rst b/docs/source/dev/compiling_and_installing/daemon.rst similarity index 100% rename from docs/source/compiling_and_installing/daemon.rst rename to docs/source/dev/compiling_and_installing/daemon.rst diff --git a/docs/source/compiling_and_installing/gnome_client.rst b/docs/source/dev/compiling_and_installing/gnome_client.rst similarity index 100% rename from docs/source/compiling_and_installing/gnome_client.rst rename to docs/source/dev/compiling_and_installing/gnome_client.rst diff --git a/docs/source/compiling_and_installing/index.rst b/docs/source/dev/compiling_and_installing/index.rst similarity index 92% rename from docs/source/compiling_and_installing/index.rst rename to docs/source/dev/compiling_and_installing/index.rst index 8d0513dde07b9c882d31a4bea26b19db75c96806..d37894e6a5f77813a85787229f5220ad5aa7c9f0 100644 --- a/docs/source/compiling_and_installing/index.rst +++ b/docs/source/dev/compiling_and_installing/index.rst @@ -1,3 +1,5 @@ +.. _building: + Compiling and installing ======================== diff --git a/docs/source/compiling_and_installing/lrc.rst b/docs/source/dev/compiling_and_installing/lrc.rst similarity index 100% rename from docs/source/compiling_and_installing/lrc.rst rename to docs/source/dev/compiling_and_installing/lrc.rst diff --git a/docs/source/compiling_and_installing/ring-project.rst b/docs/source/dev/compiling_and_installing/ring-project.rst similarity index 100% rename from docs/source/compiling_and_installing/ring-project.rst rename to docs/source/dev/compiling_and_installing/ring-project.rst diff --git a/docs/source/contributing.rst b/docs/source/dev/contributing.rst similarity index 98% rename from docs/source/contributing.rst rename to docs/source/dev/contributing.rst index 46e759bfb8e057c920e02225da92b61ab9a17bc6..1899787b8a7a6eba3e15d8dd6b80bec3d5a23348 100644 --- a/docs/source/contributing.rst +++ b/docs/source/dev/contributing.rst @@ -1,3 +1,5 @@ +.. _contributing: + Contributing ============ diff --git a/docs/source/dev/daemon b/docs/source/dev/daemon new file mode 120000 index 0000000000000000000000000000000000000000..dbc75bf3d39234868a1596f5ab861e720a0dc536 --- /dev/null +++ b/docs/source/dev/daemon @@ -0,0 +1 @@ +../../../daemon/doc/sphinx \ No newline at end of file diff --git a/docs/source/dev/gnome-client b/docs/source/dev/gnome-client new file mode 120000 index 0000000000000000000000000000000000000000..1e2794ec48141571c345f33f69eb5e279120b109 --- /dev/null +++ b/docs/source/dev/gnome-client @@ -0,0 +1 @@ +../../../client-gnome/doc/sphinx \ No newline at end of file diff --git a/docs/source/dev/lrc b/docs/source/dev/lrc new file mode 120000 index 0000000000000000000000000000000000000000..9d391788eacb87eb861f416af8471825c573e002 --- /dev/null +++ b/docs/source/dev/lrc @@ -0,0 +1 @@ +../../../lrc/doc/sphinx \ No newline at end of file diff --git a/docs/source/releasing.rst b/docs/source/dev/releasing.rst similarity index 100% rename from docs/source/releasing.rst rename to docs/source/dev/releasing.rst diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst deleted file mode 100644 index 0f3bde0a032646dbeea74bb445341469ce7fc186..0000000000000000000000000000000000000000 --- a/docs/source/getting_started.rst +++ /dev/null @@ -1,4 +0,0 @@ -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. diff --git a/docs/source/index.rst b/docs/source/index.rst index f71e39b2462ca1ebb32836ad30a4a88c2068d35d..75dbccb2b122cf8e7c49a92f29639a007b5d3c0f 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,14 +1,53 @@ 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/* diff --git a/docs/source/intro/getting_started.rst b/docs/source/intro/getting_started.rst new file mode 100644 index 0000000000000000000000000000000000000000..be183b2affedbff6fc07fe17b03798d3b4df9e65 --- /dev/null +++ b/docs/source/intro/getting_started.rst @@ -0,0 +1,8 @@ +.. _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. diff --git a/docs/source/connecting_to_ldap.rst b/docs/source/users/connecting_to_ldap.rst similarity index 100% rename from docs/source/connecting_to_ldap.rst rename to docs/source/users/connecting_to_ldap.rst diff --git a/docs/source/setting_up_turn_stun.rst b/docs/source/users/setting_up_turn_stun.rst similarity index 100% rename from docs/source/setting_up_turn_stun.rst rename to docs/source/users/setting_up_turn_stun.rst