From 7386e8794c38040b3517c3991772c950de9c3633 Mon Sep 17 00:00:00 2001
From: Manon Bourgognon <manon.bourgognon@epitech.eu>
Date: Fri, 28 May 2021 11:17:53 +0200
Subject: [PATCH] update: modications on documentation
---
source/TEST-index.rst | 48 -------------
.../Components/Solid-Auth.rst | 2 +-
.../first_step/sib-presentation.rst | 12 ++--
.../framework_guide/javascript-API.rst | 6 +-
.../framework_guide/list-base-components.rst | 20 +++---
.../list-external-components.rst | 4 +-
.../framework_guide/list-mixins.rst | 26 +++----
.../framework_guide/list-widgets.rst | 4 +-
.../javascript_API/Events.rst | 6 +-
.../javascript_API/Helpers-functions.rst | 4 +-
.../javascript_API/Store-doc.rst | 2 +
source/index.rst | 72 +++----------------
12 files changed, 57 insertions(+), 149 deletions(-)
delete mode 100644 source/TEST-index.rst
diff --git a/source/TEST-index.rst b/source/TEST-index.rst
deleted file mode 100644
index 193698b..0000000
--- a/source/TEST-index.rst
+++ /dev/null
@@ -1,48 +0,0 @@
-Welcome to Startinblox's documentation
-========================================
-
-.. toctree::
- :maxdepth: 2
- :caption: First Step
-
- import_documentation/first_step/sib-presentation
- import_documentation/first_step/get-started
- import_documentation/first_step/Solid-introduction
- import_documentation/first_step/faq
-
-.. toctree::
- :maxdepth: 2
- :caption: DjangoLDP Guide
-
- import_documentation/djangoldp_guide/install-djangoldp-server
- import_documentation/djangoldp_guide/djangoldp-references
- import_documentation/djangoldp_guide/server-architecture
-
-
-.. toctree::
- :maxdepth: 2
- :caption: Framework Guide
-
- import_documentation/framework_guide/how-to-use-the-documentation
- import_documentation/framework_guide/list-base-components
- import_documentation/framework_guide/list-external-components
- import_documentation/framework_guide/list-mixins
- import_documentation/framework_guide/attributes-list
- import_documentation/framework_guide/list-widgets
- import_documentation/framework_guide/javascript-API
-
-.. toctree::
- :maxdepth: 2
- :caption: About
-
- import_documentation/about/About-our-components
- import_documentation/about/About-semantic-web
- import_documentation/about/About-activity-pub
- import_documentation/about/About-authentification-sso
- import_documentation/about/About-the-cooperative
-
-.. toctree::
- :maxdepth: 2
- :caption: Frequent Errors
-
- import_documentation/frequent_errors/frequent-errors
diff --git a/source/import_documentation/Components/Solid-Auth.rst b/source/import_documentation/Components/Solid-Auth.rst
index 000b88e..95ea5ee 100644
--- a/source/import_documentation/Components/Solid-Auth.rst
+++ b/source/import_documentation/Components/Solid-Auth.rst
@@ -1,6 +1,6 @@
.. _sib-auth:
sib-auth
-================
+========
Allows your users to login via a given OIDC provider.
diff --git a/source/import_documentation/first_step/sib-presentation.rst b/source/import_documentation/first_step/sib-presentation.rst
index 8d26fcd..164e586 100644
--- a/source/import_documentation/first_step/sib-presentation.rst
+++ b/source/import_documentation/first_step/sib-presentation.rst
@@ -21,7 +21,7 @@ The new web standards allow the network effect to be shared between the differen
We've built a solution to make the creation of federated and interoperable applications as accessible as possible.
-.. figure:: ../_static/images/import_documentation/federation.png
+.. figure:: ../../_static/images/import_documentation/federation.png
:alt: Federation concept
=> To know more about Startin'blox, have a look to `our website <https://startinblox.com/>`__.
@@ -50,7 +50,7 @@ Startin'blox creates components according to its uses but in the future we encou
For example, Sib-Directory provides you with a user directory that includes user skills.
-.. figure:: ../_static/images/import_documentation/Components.png
+.. figure:: ../../_static/images/import_documentation/Components.png
:alt: Component example
Each component treats a specific shape of data. The validation of this shape is made on the server side.
@@ -63,7 +63,7 @@ the Linked datas platform conventions, named DjangoLDP.
It is a simple architecture on which we can add LDP packages, corresponding to the different components used.
Those are the ones that will do the work of validating the application data.
-.. figure:: ../_static/images/import_documentation/Overview-server.png
+.. figure:: ../../_static/images/import_documentation/Overview-server.png
:alt: Server overview
.. note::
@@ -72,7 +72,7 @@ Those are the ones that will do the work of validating the application data.
The solution can be summarized as follows:
-.. figure:: ../_static/images/import_documentation/Overview-of-SiB.png
+.. figure:: ../../_static/images/import_documentation/Overview-of-SiB.png
:alt: SiB overview
@@ -85,7 +85,7 @@ Overview of the Framework
Here is a brief presentation:
-.. figure:: ../_static/images/import_documentation/Framework-Overview.png
+.. figure:: ../../_static/images/import_documentation/Framework-Overview.png
:alt: Framework Overview
`To go deeper <https://git.happy-dev.fr/startinblox/framework/sib-core/>`__.
@@ -132,7 +132,7 @@ components <https://en.wikipedia.org/wiki/Web_Components>`__ that can
receive federated data sources in RDF. This means that you can only use
a component using data sources already available on the web.
-.. figure:: ../_static/images/import_documentation/federation.png
+.. figure:: ../../_static/images/import_documentation/federation.png
:alt: Federation
diff --git a/source/import_documentation/framework_guide/javascript-API.rst b/source/import_documentation/framework_guide/javascript-API.rst
index 288b8ab..c25e670 100644
--- a/source/import_documentation/framework_guide/javascript-API.rst
+++ b/source/import_documentation/framework_guide/javascript-API.rst
@@ -6,6 +6,6 @@ This section presents how you can use Javascript API with sib-core.
.. toctree::
:maxdepth: 1
- import_documentation/javascript_API/Events
- import_documentation/javascript_API/Helpers-functions
- import_documentation/javascript_API/Store-doc
\ No newline at end of file
+ :ref:`Events <events>`
+ :ref:`Javascript Helpers <javascript-helpers>`
+ :ref:`Store documentation <store-documentation>`
\ No newline at end of file
diff --git a/source/import_documentation/framework_guide/list-base-components.rst b/source/import_documentation/framework_guide/list-base-components.rst
index ad360d9..284d5eb 100644
--- a/source/import_documentation/framework_guide/list-base-components.rst
+++ b/source/import_documentation/framework_guide/list-base-components.rst
@@ -9,13 +9,13 @@ The base components are :
.. toctree::
:maxdepth: 1
- import_documentation/Components/Solid-Ac-Checker
- import_documentation/Components/Solid-Calendar
- import_documentation/Components/Solid-Display
- import_documentation/Components/Solid-Delete
- import_documentation/Components/Solid-Form
- import_documentation/Components/Solid-Form-Search
- import_documentation/Components/Solid-Lang
- import_documentation/Components/Solid-Map
- import_documentation/Components/Solid-Table
- import_documentation/Components/Solid-Widget
\ No newline at end of file
+ :ref:`solid-ac-checker <solid-ac-checker>`
+ :ref:`solid-calendar <solid-calendar>`
+ :ref:`solid-display <solid-display>`
+ :ref:`solid-delete <solid-delete>`
+ :ref:`solid-form <solid-form>`
+ :ref:`solid-form-search <solid-form-search>`
+ :ref:`solid-lang <solid-lang>`
+ :ref:`solid-map <solid-map>`
+ :ref:`solid-table <solid-table>`
+ :ref:`solid-widget <solid-widget>`
\ No newline at end of file
diff --git a/source/import_documentation/framework_guide/list-external-components.rst b/source/import_documentation/framework_guide/list-external-components.rst
index d06d64a..21c4bea 100644
--- a/source/import_documentation/framework_guide/list-external-components.rst
+++ b/source/import_documentation/framework_guide/list-external-components.rst
@@ -7,5 +7,5 @@ however they can be used to add useful features such as authentication and route
.. toctree::
:maxdepth: 1
- import_documentation/Components/Solid-Auth
- import_documentation/Components/Solid-Router
+ :ref:`solid-auth <sib-auth>`
+ :ref:`solid-router <solid-router>`
diff --git a/source/import_documentation/framework_guide/list-mixins.rst b/source/import_documentation/framework_guide/list-mixins.rst
index 603516f..16f7362 100644
--- a/source/import_documentation/framework_guide/list-mixins.rst
+++ b/source/import_documentation/framework_guide/list-mixins.rst
@@ -7,16 +7,16 @@ the base components to best render the content of the application :
.. toctree::
:maxdepth: 1
- import_documentation/Mixins/counter-mixin
- import_documentation/Mixins/federation-mixin
- import_documentation/Mixins/filter-mixin
- import_documentation/Mixins/grouper-mixin
- import_documentation/Mixins/highlighter-mixin
- import_documentation/Mixins/list-mixin
- import_documentation/Mixins/next-mixin
- import_documentation/Mixins/paginate-mixin
- import_documentation/Mixins/required-mixin
- import_documentation/Mixins/sorter-mixin
- import_documentation/Mixins/store-mixin
- import_documentation/Mixins/validation-mixin
- import_documentation/Mixins/widget-mixin
+ :ref:`counter-mixin <counter-mixin>`
+ :ref:`federation-mixin <federation-mixin>`
+ :ref:`filter-mixin <filter-mixin>`
+ :ref:`grouper-mixin <grouper-mixin>`
+ :ref:`highlighter-mixin <highlighter-mixin>`
+ :ref:`list-mixin <list-mixin>`
+ :ref:`next-mixin <next-mixin>`
+ :ref:`paginate-mixin <paginate-mixin>`
+ :ref:`required-mixin <required-mixin>`
+ :ref:`sorter-mixin <sorter-mixin>`
+ :ref:`store-mixin <store-mixin>`
+ :ref:`validation-mixin <validation-mixin>`
+ :ref:`widget-mixin <widget-mixin>`
diff --git a/source/import_documentation/framework_guide/list-widgets.rst b/source/import_documentation/framework_guide/list-widgets.rst
index 3dac4e0..e8d0fb7 100644
--- a/source/import_documentation/framework_guide/list-widgets.rst
+++ b/source/import_documentation/framework_guide/list-widgets.rst
@@ -7,5 +7,5 @@ How to create them and how to use them are precised :
.. toctree::
:maxdepth: 1
- import_documentation/Widgets/Reference
- import_documentation/Widgets/Examples
\ No newline at end of file
+ :ref:`Widget API Reference <reference>`
+ :ref:`Examples <examples>`
\ No newline at end of file
diff --git a/source/import_documentation/javascript_API/Events.rst b/source/import_documentation/javascript_API/Events.rst
index c94aa3c..4203006 100644
--- a/source/import_documentation/javascript_API/Events.rst
+++ b/source/import_documentation/javascript_API/Events.rst
@@ -1,5 +1,7 @@
+.. _events:
+
Events
-------
+======
Our objective is to use the minimum of javascript.
@@ -28,7 +30,7 @@ But for now, here are some events that will be useful to you.
+------+---------+------------------------+---------------------------+
Examples
-~~~~~~~~
+--------
``populate``
^^^^^^^^^^^^
diff --git a/source/import_documentation/javascript_API/Helpers-functions.rst b/source/import_documentation/javascript_API/Helpers-functions.rst
index 8208ec0..a49ad21 100644
--- a/source/import_documentation/javascript_API/Helpers-functions.rst
+++ b/source/import_documentation/javascript_API/Helpers-functions.rst
@@ -1,5 +1,7 @@
+.. _javascript-helpers:
+
Javascript Helpers
-=====================
+==================
Helpers fonctions
-----------------
diff --git a/source/import_documentation/javascript_API/Store-doc.rst b/source/import_documentation/javascript_API/Store-doc.rst
index 3f57566..afad8b2 100644
--- a/source/import_documentation/javascript_API/Store-doc.rst
+++ b/source/import_documentation/javascript_API/Store-doc.rst
@@ -1,3 +1,5 @@
+.. _store-documentation:
+
Store documentation
====================
diff --git a/source/index.rst b/source/index.rst
index 9861761..33f4a79 100644
--- a/source/index.rst
+++ b/source/index.rst
@@ -6,8 +6,8 @@ Welcome to Startinblox's documentation
:caption: First Step
import_documentation/first_step/sib-presentation
- import_documentation/first_step/Solid-introduction
import_documentation/first_step/get-started
+ import_documentation/first_step/Solid-introduction
import_documentation/first_step/faq
.. toctree::
@@ -18,81 +18,31 @@ Welcome to Startinblox's documentation
import_documentation/djangoldp_guide/djangoldp-references
import_documentation/djangoldp_guide/server-architecture
+
.. toctree::
:maxdepth: 2
- :caption: Get started with sib-core
+ :caption: Framework Guide
import_documentation/framework_guide/how-to-use-the-documentation
+ import_documentation/framework_guide/list-base-components
+ import_documentation/framework_guide/list-external-components
+ import_documentation/framework_guide/list-mixins
import_documentation/framework_guide/attributes-list
+ import_documentation/framework_guide/list-widgets
+ import_documentation/framework_guide/javascript-API
.. toctree::
- :maxdepth: 2
- :caption: Base components
-
- import_documentation/Components/Solid-Display
- import_documentation/Components/Solid-Form
- import_documentation/Components/Solid-Form-Search
- import_documentation/Components/Solid-Delete
- import_documentation/Components/Solid-Calendar
- import_documentation/Components/Solid-Map
- import_documentation/Components/Solid-Ac-Checker
- import_documentation/Components/Solid-Widget
- import_documentation/Components/Solid-Lang
- import_documentation/Components/Solid-Table
-
-.. toctree::
- :maxdepth: 2
- :caption: External components
-
- import_documentation/Components/Solid-Auth
- import_documentation/Components/Solid-Router
-
-
-.. toctree::
- :maxdepth: 2
- :caption: Mixins
-
- import_documentation/Mixins/store-mixin
- import_documentation/Mixins/widget-mixin
- import_documentation/Mixins/list-mixin
- import_documentation/Mixins/counter-mixin
- import_documentation/Mixins/federation-mixin
- import_documentation/Mixins/grouper-mixin
- import_documentation/Mixins/filter-mixin
- import_documentation/Mixins/paginate-mixin
- import_documentation/Mixins/sorter-mixin
- import_documentation/Mixins/highlighter-mixin
- import_documentation/Mixins/required-mixin
- import_documentation/Mixins/next-mixin
- import_documentation/Mixins/validation-mixin
-
-.. toctree::
- :maxdepth: 2
- :caption: Widgets
-
- import_documentation/Widgets/Reference
- import_documentation/Widgets/Examples
-
-.. toctree::
- :maxdepth: 2
- :caption: Javascript API
-
- import_documentation/javascript_API/Events
- import_documentation/javascript_API/Helpers-functions
- import_documentation/javascript_API/Store-doc
-
- .. toctree::
:maxdepth: 2
:caption: About
import_documentation/about/About-our-components
import_documentation/about/About-semantic-web
import_documentation/about/About-activity-pub
- import_documentation/about/About-authentication-sso
+ import_documentation/about/About-authentification-sso
import_documentation/about/About-the-cooperative
- .. toctree::
+.. toctree::
:maxdepth: 2
:caption: Frequent Errors
- import_documentation/frequent_errors/frequent-errors
+ import_documentation/frequent_errors/frequent-errors
\ No newline at end of file
--
GitLab