Skip to content

Commit b95c614

Browse files
committed
[FEATURE] Support basic glossary directive
Support glossary directive containing a definition list. Multiple terms, groups and :sorted: flag are not yet supported https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-glossary resolves: #928 releases: main, 1.0
1 parent 566af8b commit b95c614

File tree

3 files changed

+34
-0
lines changed

3 files changed

+34
-0
lines changed
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<div class="{{ node.glossary }}">{{ renderNode(node.value) }}</div>
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<!-- content start -->
2+
<div class="section" id="directive-tests">
3+
<h1>Directive tests</h1>
4+
5+
<div class=""><dl>
6+
<dt>environment</dt>
7+
8+
<dd>A structure where information about all documents under the root is
9+
saved, and used for cross-referencing. The environment is pickled
10+
after the parsing stage, so that successive runs only need to read
11+
and parse new and changed documents.</dd> <dt>source directory</dt>
12+
13+
<dd>The directory which, including its subdirectories, contains all
14+
source files for one documentation project.</dd> </dl>
15+
</div>
16+
17+
</div>
18+
19+
<!-- content end -->
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
Directive tests
2+
===============
3+
4+
.. glossary::
5+
6+
environment
7+
A structure where information about all documents under the root is
8+
saved, and used for cross-referencing. The environment is pickled
9+
after the parsing stage, so that successive runs only need to read
10+
and parse new and changed documents.
11+
12+
source directory
13+
The directory which, including its subdirectories, contains all
14+
source files for one documentation project.

0 commit comments

Comments
 (0)