Skip to content

Commit 9fbb6f7

Browse files
committed
Include module name in the fact docs, fix fact reference on doc index.
1 parent d2242de commit 9fbb6f7

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Deploy Reference
3838

3939
.. compound::
4040
:doc:`facts`
41-
A list of all facts ``pyinfra`` can gather from hosts, e.g. ``host.fact.os``.
41+
A list of all facts ``pyinfra`` can gather from hosts, e.g. ``server.Hostname``.
4242

4343
.. compound::
4444
:doc:`examples`

scripts/generate_facts_docs.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ def build_facts():
7979
if arg != 'self'
8080
))
8181

82-
title = ':code:`{0}`'.format(name)
82+
title = ':code:`{0}.{1}`'.format(module_name, name)
8383
lines.append(title)
8484

8585
# Underline name with -'s for title

0 commit comments

Comments
 (0)