cheche
April 22, 2024, 7:02am
1
I was reading documentation about notification email, and I thought that our docs could be improved adding a link to all the email settings.
So I created a merge request:
Now it is failing because it does not like the seealso directive.
But I did copy from the Party documentation, so I am not sure what I did wrong.
Can anyone tell me what is wrong with that code?
ced
(Cédric Krier)
April 22, 2024, 7:08am
2
Rest directives can not be used in the long_description of the package (which is the index.rst
).
cheche
April 22, 2024, 7:23am
3
Got it @ced .
It is not big deal, but How do you feel about adding a link of the email settings on index.rst?
ced
(Cédric Krier)
April 22, 2024, 7:29am
4
I would prefer to have a full upgrade of the documentation to Tryton - Documentation Guidelines which may include reference to the email configuration.
cheche
April 22, 2024, 5:20pm
5
I am trying to reference to the email configuracion, but the closer I had get is:
- See also :doc:`Email settings <trytond:topics/configuration>`.
But my idea is to refer to
/latest/server/topics/configuration.html#email
ced
(Cédric Krier)
April 22, 2024, 5:43pm
6
There is this comment to add anchor on configuration.
cheche
April 22, 2024, 7:57pm
7
ok. I am happy to create the anchors for each section on the configuracion.
Is this list correct for you?
configuration-web
configuration-database
configuration-request
configuration-cache
configuration-queue
configuration-error
configuration-table
configuration-ssl
configuration-email
configuration-session
configuration-password
configuration-attachment
configuration-bus
configuration-html
configuration-wsgi_middleware
ced
(Cédric Krier)
April 22, 2024, 8:34pm
8
I think we should have the same format as in modules so it would be: config-<section>.<name>
. Eg:
.. _config-web:
.. _config-web.listen:
.. _config-web.hostname:
ced
(Cédric Krier)
Split this topic
April 26, 2024, 6:45am
9
2 posts were split to a new topic: Remove commit from a topic
cheche
April 28, 2024, 7:44am
10
Reading documentation, looks like you need add the label description when adding a label without section
https://www.sphinx-doc.org/en/master/usage/referencing.html#role-ref
:ref:`config-web`
:ref:`Configuration web listen <config-web.listen>`
so to move forward… maybe just create the anchors for each section until find another cleaner way to refer to the config.section.name?
ced
(Cédric Krier)
April 28, 2024, 10:35am
11
They all are a title section.
cheche
April 28, 2024, 11:37am
12
ok. My misinterpretation about subsections. Test it and it works.
I review my MergeRequest and the first commit disappear… I will try to create a new one…Thanks for your patience.
ced
(Cédric Krier)
April 28, 2024, 12:00pm
13
This is mercurial, you must amend not add commit. Adding commits make reviewing a painful task.
ced
(Cédric Krier)
April 28, 2024, 12:07pm
14
Except of course if there should be two commits because it is two different changes.