From 1b19989a5541acbdb0eb5f7a451736a576ca3f11 Mon Sep 17 00:00:00 2001
From: aviau <alexandre@alexandreviau.net>
Date: Tue, 7 Jun 2016 14:29:42 -0400
Subject: [PATCH] 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
---
.../compiling_and_installing/daemon.rst | 0
.../compiling_and_installing/gnome_client.rst | 0
.../compiling_and_installing/index.rst | 2 +
.../compiling_and_installing/lrc.rst | 0
.../compiling_and_installing/ring-project.rst | 0
docs/source/{ => dev}/contributing.rst | 2 +
docs/source/dev/daemon | 1 +
docs/source/dev/gnome-client | 1 +
docs/source/dev/lrc | 1 +
docs/source/{ => dev}/releasing.rst | 0
docs/source/getting_started.rst | 4 --
docs/source/index.rst | 55 ++++++++++++++++---
docs/source/intro/getting_started.rst | 8 +++
.../source/{ => users}/connecting_to_ldap.rst | 0
.../{ => users}/setting_up_turn_stun.rst | 0
15 files changed, 62 insertions(+), 12 deletions(-)
rename docs/source/{ => dev}/compiling_and_installing/daemon.rst (100%)
rename docs/source/{ => dev}/compiling_and_installing/gnome_client.rst (100%)
rename docs/source/{ => dev}/compiling_and_installing/index.rst (92%)
rename docs/source/{ => dev}/compiling_and_installing/lrc.rst (100%)
rename docs/source/{ => dev}/compiling_and_installing/ring-project.rst (100%)
rename docs/source/{ => dev}/contributing.rst (98%)
create mode 120000 docs/source/dev/daemon
create mode 120000 docs/source/dev/gnome-client
create mode 120000 docs/source/dev/lrc
rename docs/source/{ => dev}/releasing.rst (100%)
delete mode 100644 docs/source/getting_started.rst
create mode 100644 docs/source/intro/getting_started.rst
rename docs/source/{ => users}/connecting_to_ldap.rst (100%)
rename docs/source/{ => users}/setting_up_turn_stun.rst (100%)
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 8d0513dd..d37894e6 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 46e759bf..1899787b 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 00000000..dbc75bf3
--- /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 00000000..1e2794ec
--- /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 00000000..9d391788
--- /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 0f3bde0a..00000000
--- 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 f71e39b2..75dbccb2 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 00000000..be183b2a
--- /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
--
GitLab