Skip to content

Commit 35bb220

Browse files
committed
doc: generic grammar, formatting, etc.
Signed-off-by: James Knight <[email protected]>
1 parent 701ea3e commit 35bb220

File tree

8 files changed

+23
-11
lines changed

8 files changed

+23
-11
lines changed

doc/configuration.rst

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1650,7 +1650,7 @@ Advanced publishing configuration
16501650
no changes are detected on the Confluence instance. When a page is
16511651
published by this extension, a hash of the page will be stored on the
16521652
Confluence page. This hash can be referred to later by hosts using this
1653-
extension, by query the hash and comparing it against a locally prepared
1653+
extension, by querying the hash and comparing it against a locally prepared
16541654
page update. If hashes match, no attempt will be made to update the
16551655
specific page. If users are experiencing issues with this check, they may
16561656
force publishing by configuring this option to ``True``. By default, this
@@ -1695,7 +1695,7 @@ Advanced publishing configuration
16951695

16961696
.. versionadded:: 1.3
16971697

1698-
A publish event will from this extension will typically upload new pages or
1698+
A publish event from this extension will typically upload new pages or
16991699
update existing pages on future attempts. In select cases, a user may not
17001700
wish to modify existing pages and only permit adding new content to a
17011701
Confluence space. To achieve this, a user can enable an "only-new" flag
@@ -1733,7 +1733,7 @@ Advanced publishing configuration
17331733

17341734
.. versionadded:: 2.1
17351735

1736-
The page identifier of the page to hold orphan pages. The parent page
1736+
The identifier of the page to hold orphan pages. The parent page
17371737
associated to an orphan page can vary per configuration. When a user
17381738
configures for a parent page/root, orphan pages will be placed under the
17391739
respective parent page/root configuration. If no parent page/root is
@@ -2080,7 +2080,7 @@ Advanced processing configuration
20802080

20812081
.. code-block:: rst
20822082
2083-
For more information, contact :confluence_mention:`myuser`:
2083+
For more information, contact :confluence_mention:`myuser`.
20842084
20852085
The value ``myuser`` will be replaced with the configured account
20862086
identifier. This can be useful for when trying to manage multiple
@@ -2205,6 +2205,10 @@ Third-party related options
22052205
include Mermaid JS support. For example, adding the following content
22062206
on the page planning to render diagrams:
22072207

2208+
.. raw:: latex
2209+
2210+
{\footnotesize
2211+
22082212
.. code-block:: rst
22092213
22102214
.. confluence_html::
@@ -2213,6 +2217,10 @@ Third-party related options
22132217
import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.esm.min.mjs';
22142218
</script>
22152219
2220+
.. raw:: latex
2221+
2222+
}
2223+
22162224
When using the `sphinxcontrib-mermaid`_ extension, this option can be
22172225
used pass raw Mermaid figures into an HTML macro.
22182226

doc/events.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ Events
33

44
The following outlines additional `events`_ supported by this extension.
55

6+
Generic events
7+
--------------
8+
69
.. event:: confluence-publish-point (app, point_url)
710

811
:param app: :class:`.Sphinx`

doc/features.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -298,9 +298,9 @@ Other
298298
-----
299299

300300
If a feature or extension is not listed above, is not working as expected or
301-
brings up another concern, feel free to bring up an issue:
301+
has another concern, feel free to bring up an issue:
302302

303-
| Atlassian Confluence Builder for Confluence - Issues
303+
| Atlassian Confluence Builder for Confluence Issues
304304
| https://github.com/sphinx-contrib/confluencebuilder/issues
305305
306306

doc/guide-confluence-macros.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ the following in a reStructuredText document:
3333
3434
.. raw:: confluence_storage
3535
36-
<ac:structured-macro ac:name="cheese" ac:macro-id="5d87ef61-1fcf-4d30-8d3b-82305e13233a" />
36+
<ac:structured-macro ac:name="cheese"
37+
ac:macro-id="5d87ef61-1fcf-4d30-8d3b-82305e13233a" />
3738
3839
Or create an `"Info" macro`_ in a Markdown document:
3940

doc/install-virtualenv.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ Windows (virtualenv)
9393

9494
If not already installed, download the most recent version of Python_:
9595

96-
| Python - Downloads
96+
| Python Downloads
9797
| https://www.python.org/downloads/
9898
9999
When invoking the installer, it is recommended to select the option to "Add

doc/install.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ Windows
9999

100100
If not already installed, download the most recent version of Python_:
101101

102-
| Python - Downloads
102+
| Python Downloads
103103
| https://www.python.org/downloads/
104104
105105
When invoking the installer, it is recommended to select the option to "Add

doc/roles.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ generated Confluence documents.
110110
See :confluence_mention:`3c5369:fa8b5c24-17f8-4340-b73e-50d383307c59`.
111111
112112
For Confluence Data Center, a mention to a specific user can either
113-
be set to the username value, or a user's key value:
113+
be set to the username value or a user's key value:
114114

115115
.. code-block:: rst
116116

doc/tips.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ Asking for help
108108
Having trouble or concerns using this extension? Do not hesitate to bring up an
109109
issue:
110110

111-
| Atlassian Confluence Builder for Confluence - Issues
111+
| Atlassian Confluence Builder for Confluence Issues
112112
| https://github.com/sphinx-contrib/confluencebuilder/issues
113113
114114
For issues when using this extension, generating a report and including this

0 commit comments

Comments
 (0)