Merge pull request #26 from LibreSign/fix/warnings

vitormattos · web-flow · commit f2fb2d458889 · 2025-05-29T12:58:01.000-03:00
fix: warnings
diff --git a/docs/Makefile b/docs/Makefile
@@ -22,15 +22,15 @@
 .PHONY: main user admin dev all
 
 main:
-	sphinx-build -b html main ../_build
+	sphinx-build main ../_build
 
 user:
-	sphinx-build -b html user_manual user_manual ../_build
+	sphinx-build user_manual ../_build
 
 admin:
-	sphinx-build -b html admin_manual admin_manual ../_build
+	sphinx-build admin_manual ../_build
 
 dev:
-	sphinx-build -b html developer_manual developer_manual ../_build
+	sphinx-build developer_manual ../_build
 
 all: main user admin dev
diff --git a/docs/admin_manual/introduction.rst b/docs/admin_manual/introduction.rst
@@ -1,19 +1,19 @@
 Introduction
-==========
+============
 
 What is Libresign?
--------------------
+------------------
 
 Libresign is a software package that provides a set of tools for working with digital signatures. It is designed to be easy to use and flexible, allowing you to integrate it into your own applications or use it as a standalone tool.
 
 Videos and blogs
-------------------
+----------------
 
 Visit our `blog <https://libresign.coop/posts/>`__
 
 Target audience
-----------------
+---------------
 
- - Public sector
- - Education
- - Private companies
+- Public sector
+- Education
+- Private companies
diff --git a/docs/developer_manual/api.rst b/docs/developer_manual/api.rst
@@ -1,13 +1,6 @@
 API
 ===
 
-.. autosummary::
-   :toctree: generated
-
-.. redoc::
-   :spec-url: https://libresign.github.io/api/openapi.yaml
-   :embed:
-
 .. raw:: html
 
    <link rel="stylesheet" href="swagger-ui.css" />
diff --git a/docs/developer_manual/examples_on_insomnia.rst b/docs/developer_manual/examples_on_insomnia.rst
diff --git a/docs/developer_manual/guide-api.rst b/docs/developer_manual/guide-api.rst
@@ -1,22 +1,22 @@
 Guide API
-================
+=========
 
 Prerequisites
------------------
+-------------
 
- - All requests require a <code> Content-Type </code> of application/json.
- - The API is located at `here <https://nextcloud.local/index.php/apps/libresign/api/v1.0/>`__
- - All request parameters are required, unless otherwise specified
+- All requests require a <code> Content-Type </code> of application/json.
+- The API is located at `here <https://nextcloud.local/index.php/apps/libresign/api/v1.0/>`__
+- All request parameters are required, unless otherwise specified
 
 
 Examples on Insomnia
-----------------------
+--------------------
 
 You can download `here <https://libresign.github.io/Insomnia_2021-11-24.json/>`__ an example of request to API.
 
 
 Headers
------------------
+-------
 
 `Read <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization/>`__
 
@@ -46,15 +46,15 @@ Example:
 
 
 Endpoints
-----------------
+---------
 
 .. _Single flow:
 
 Single flow
---------------
+-----------
 
 Request signature
-^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^
 POST /request-signature
 
 .. code-block::
@@ -83,7 +83,7 @@ You will receive the fileId or UUID, store this data to create visible elements.
 
 
 Validate
-^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^
 
 Get data of a specific file, you can use file_id or uuid on path, both data you will receive after request to POST /request-signature
 
@@ -96,7 +96,7 @@ The association between user and file will result on a signRequestId. You will n
         --header 'Authorization: Basic YWRtaW46YWRtaW4='
 
 List files
-^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^
 List all LibreSign files
 
 .. code-block::
@@ -106,10 +106,10 @@ List all LibreSign files
         --header 'Authorization: Basic YWRtaW46YWRtaW4=' \
 
 Visible elements
-^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^
 
 Create
-+++++++++++++++++
+++++++
 
 POST /file/{uuid}/elements
 
@@ -132,7 +132,7 @@ POST /file/{uuid}/elements
         }'
 
 Update
-+++++++++++++++++
+++++++
 
 PATCH /file/{uuid}/elements/{elementId}
 
@@ -157,13 +157,13 @@ The UUID you will receive when you will do a request to POST /request-signature
         }'
 
 Delete
-+++++++++++++++++
+++++++
 
 DELETE /file/{uuid}/elements/{elementId}
 
 
 Define sign password
-^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^
 
 If the system is enabled to sign using password, the user will need to create a password to sign the file.
 
@@ -178,7 +178,7 @@ If the system is enabled to sign using password, the user will need to create a
         }'
 
 Changing status
-^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^
 
 You will need change the status of a file from draft to able to sign. When you change the status, all users will receive an email with URL to create account if the user don't exists or authenticate and sign the file.
 
@@ -199,7 +199,7 @@ You will need change the status of a file from draft to able to sign. When you c
         }'
 
 Define user signature
-^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^
 
 This is necessary for all user to store the own signature or initial.
 
@@ -227,15 +227,15 @@ This is necessary for all user to store the own signature or initial.
         }'
 
 Sign method
-^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^
 
 You can change the sign method between password, email, sms, telegram or signal.
 
 To sign using SMS you will need install the app twofactor_gateway and configure the gateway to SMS.
 
 Example:
 
-.. code-block:: docker-compose
+.. code-block:: bash
 
     docker-compose exec --user www-data nextcloud php occ config:app:set libresign identify_method --value=["nextcloud"]
 
@@ -244,16 +244,16 @@ Example:
     docker-compose exec --user www-data nextcloud php occ config:app:set libresign identify_method --value=["sms"]
 
 SMS
-+++++++++++++
++++
 
 Configuring the SMS gateway.
 
-.. code-block:: docker-compose
+.. code-block:: bash
 
     docker-compose exec --user www-data nextcloud php occ twofactorauth:gateway:configure sms
 
 Define phone number
-+++++++++++++++++++++
++++++++++++++++++++
 
 To sign using SMS the user will need define the phone number.
 
@@ -268,7 +268,7 @@ To sign using SMS the user will need define the phone number.
         }'
 
 Request code
-+++++++++++++++++++++
+++++++++++++
 
 If the sign method is a code, the authenticated user will need request a code to sign the file.
 
@@ -279,7 +279,7 @@ If the sign method is a code, the authenticated user will need request a code to
     --header 'Content-Type: application/json' \
 
 Sign using code
-+++++++++++++++++++++
++++++++++++++++
 
 To sign you only will need send the code that you received by email or SMS.
 
diff --git a/docs/developer_manual/headers.rst b/docs/developer_manual/headers.rst
diff --git a/docs/developer_manual/prerequisites.rst b/docs/developer_manual/prerequisites.rst
diff --git a/docs/user_manual/faq.rst b/docs/user_manual/faq.rst
@@ -1,8 +1,8 @@
 FAQ(Frequently Asked Questions)
-=================
+===============================
 
 Questions
--------------
+---------
 
 1. Why LibreSign?
 
diff --git a/docs/user_manual/introduction.rst b/docs/user_manual/introduction.rst
@@ -1,15 +1,14 @@
 Introduction
-==========
+============
 
 What is Libresign?
--------------------
+------------------
 
 Libresign is a software package that provides a set of tools for working with digital signatures. It is designed to be easy to use and flexible, allowing you to integrate it into your own applications or use it as a standalone tool.
 
 Target audience
-----------------
+---------------
 
- - Public sector
- - Education
- - Private companies
- 
+- Public sector
+- Education
+- Private companies
diff --git a/docs/user_manual/suport.rst b/docs/user_manual/suport.rst
@@ -1,5 +1,5 @@
 Suport LibreSign
-=======
+================
 
 If you have questions, find errors or need help using LibreSign, please contact the LibreCode team.
 
