Skip to content

Commit b435e69

Browse files
committed
docs: Some ref fixes
1 parent ba4f667 commit b435e69

3 files changed

Lines changed: 8 additions & 6 deletions

File tree

docs/conf.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ The extension provides the following configuration:
88
:type: int
99
:default: 10
1010

11-
The default count of recent revisions. See Functionalities_.
11+
The default count of recent revisions. See :doc:`usage`.
1212

1313
.. confval:: recentupdate_template
1414
:type: str
1515
:default: see below
1616

17-
The default Jinja template of update information. See Functionalities_.
17+
The default Jinja template of update information. See :doc:`usage`.
1818

1919
Here is the default value:
2020

@@ -40,7 +40,7 @@ The extension provides the following configuration:
4040
:type: str
4141
:default: "%Y-%m-%dT"
4242

43-
The default date format of strftime_ filter.
43+
The default date format of :ref:`strftime` filter.
4444

4545
.. confval:: recentupdate_exclude_path
4646
:type: List[str]

docs/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Introduction
3030
3131
Get the document update information from git and display it in Sphinx documentation.
3232

33-
This extensions provides a :doc:`recentupdate <usgae>`_ directive, which can show recent document update of current Sphinx documentation. The update information is read from Git_ repository (So you must use Git to manage your documentation). You can customize the update information through generating reStructuredText from Jinja_ template.
33+
This extensions provides a :doc:`recentupdate <usage>` directive, which can show recent document update of current Sphinx documentation. The update information is read from Git_ repository (So you must use Git to manage your documentation). You can customize the update information through generating reStructuredText from Jinja_ template.
3434

3535
.. _Git: https://git-scm.com/
3636
.. _Jinja: https://jinja.palletsprojects.com/en/3.0.x/templates/
@@ -69,7 +69,7 @@ Then, add the extension name to ``extensions`` configuration item in your
6969

7070
.. ADDITIONAL CONTENT START
7171
72-
Add ``recentupdate`` directive to your document, Build your document, the directive will be rendered to:
72+
Add ``recentupdate`` directive to your document, build your document, the directive will be rendered to:
7373

7474
.. example::
7575
:style: grid

docs/usage.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ All available variables_:
3434
{{ revisions }}
3535
---------------
3636

37-
``{{ revisions }}`` is an an array of revisions. The length of array is determined by the argument of`recentupdate <Functionalities>`_ directive.
37+
``{{ revisions }}`` is an an array of revisions. The length of array is determined by the argument of ``recentupdate`` directive.
3838

3939
Here is the schema of array element:
4040

@@ -44,6 +44,8 @@ Here is the schema of array element:
4444
Filters
4545
=======
4646

47+
.. _strftime:
48+
4749
strftime
4850
--------
4951

0 commit comments

Comments
 (0)