Enhancement #2700
Support Sphinx RST text roles
Status: | CLOSED | Start date: | ||
---|---|---|---|---|
Priority: | Normal | Due date: | ||
Assignee: | - | % Done: | 100% | |
Category: | nethserver-devtools | |||
Target version: | v6.5-final | |||
Resolution: | NEEDINFO: | No |
Description
Sphinx provides some useful semantic RST text roles for our documentation:
http://sphinx-doc.org/markup/inline.html
Define them as RST custom text roles to compile online documentation.
Associated revisions
launch /usr/bin/odbcinst by nethserver-unixODBC-install action, called by nethserver-unixODBC-update event after templates expansion. Refs #2700
History
#1 Updated by Davide Principi over 7 years ago
- Status changed from TRIAGED to ON_DEV
- Assignee set to Davide Principi
- % Done changed from 20 to 30
#2 Updated by Davide Principi over 7 years ago
- Status changed from ON_DEV to MODIFIED
- Assignee deleted (
Davide Principi) - % Done changed from 30 to 60
Test case
In a testing installation, move to /usr/share/nethesis/NethServer/Help/en
.
Edit an .rst
file, by adding :guilabel:
role somewhere:
To install or remove the listed software components, change the checkbox states then click the :guilabel:`Apply` button.
Install the modified version then run:
# make -f /usr/share/nethserver-devtools/docs.mk <MODULE_HELP>.html
The HTML output must hold the following fragment:
<span class="guilabel">Apply</span>
#3 Updated by Davide Principi over 7 years ago
- Status changed from MODIFIED to ON_QA
- % Done changed from 60 to 70
In nethserver-testing:
nethserver-devtools-1.1.1-1.0git0707d9fd.ns6.noarch.rpm
#4 Updated by Giacomo Sanchietti over 7 years ago
- Assignee set to Giacomo Sanchietti
#5 Updated by Giacomo Sanchietti over 7 years ago
- Status changed from ON_QA to VERIFIED
- Assignee deleted (
Giacomo Sanchietti) - % Done changed from 70 to 90
The guilablel
marker is applied correctly:
[root@localhost en]# grep underscore NethServer_Module_Group.rst hyphens, and :guilabel:`underscores` and must start with [root@localhost en]# grep underscore NethServer_Module_Group.html hyphens, and <span class="guilabel">underscores</span> and must start with
#6 Updated by Davide Principi over 7 years ago
- Status changed from VERIFIED to CLOSED
- % Done changed from 90 to 100
In nethserver-updates:
nethserver-devtools-1.1.2-1.ns6.noarch.rpm