Skip to content

Commit 993aaa2

Browse files
Anthony Sansoneatsansone
authored andcommitted
(DOCSP-11378) Update text formatting page
1 parent db3c507 commit 993aaa2

File tree

28 files changed

+5629
-3794
lines changed

28 files changed

+5629
-3794
lines changed

Makefile

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ help: ## Show this help message
2020
html: ## Builds this branch's HTML under build/<branch>/html
2121
giza make html
2222

23+
clean-html:
24+
rm -rf build/${GIT_BRANCH}
25+
giza make html
26+
2327
publish: ## Builds this branch's publishable HTML and other artifacts under build/public
2428
giza make publish
2529

source/reference/source-constants.txt

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,15 @@
22
Source Constants
33
================
44

5-
The `substitutions <http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#substitution-definitions>`__
6-
built into restructuredText have a number of limitations and quirks. For
7-
example, they cannot be used to substitute content inside of code blocks,
8-
and cannot contain links.
5+
The `substitutions
6+
<http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#substitution-definitions>`__
7+
built into restructuredText have a number of limitations and quirks.
8+
For example, they cannot be used to substitute content inside of code
9+
blocks, and cannot contain links.
910

10-
The MongoDB Documentation Project has an extension called ``source_constants``
11-
which allows you to substitute constants anywhere in a page *before*
12-
docutils begins its parse stage.
11+
The MongoDB Documentation Project has an extension called
12+
``source_constants`` which allows you to substitute constants anywhere
13+
in a page *before* docutils begins its parse stage.
1314

1415
Example
1516
-------
@@ -18,6 +19,7 @@ In your ``conf.py``, add ``'source_constants'`` to the ``extensions``
1819
list, and define a ``source_constants`` dict:
1920

2021
.. code-block:: python
22+
:linenos:
2123

2224
source_constants = {
2325
'package-branch': 'testing',
@@ -29,13 +31,15 @@ You may then use these constants in your restructuredText files:
2931

3032
.. code-block:: rst
3133

32-
Create the ``/etc/apt/sources.list.d/mongodb-org-{+package-version+}.list`` list file using
33-
the command appropriate for your version of Ubuntu:
34+
Create the
35+
``/etc/apt/sources.list.d/mongodb-org-{+package-version+}.list``
36+
list file using the command appropriate for your version of Ubuntu:
3437

35-
Ubuntu 14.04
36-
.. code-block:: sh
38+
.. code-block:: sh
3739

38-
echo "deb [ arch=amd64 ] https://repo.mongodb.org/apt/ubuntu trusty/mongodb-org/{+package-branch+} multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-{+version+}.list
40+
echo "deb [ arch=amd64 ] https://repo.mongodb.org/apt/ubuntu \
41+
trusty/mongodb-org/{+package-branch+} multiverse" \
42+
| sudo tee /etc/apt/sources.list.d/mongodb-org-{+version+}.list
3943

4044
Comparison with Other Variable Syntaxes
4145
---------------------------------------
@@ -62,7 +66,8 @@ Comparison with Other Variable Syntaxes
6266
* - Valid Content
6367
- Anything
6468
- Anything
65-
- May not be used to inject links or other non-trivial types of content
69+
- May not be used to inject links or other non-trivial types of
70+
content
6671

6772
* - Mutable
6873
- Can currently only be defined in ``conf.py``
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
#
2+
-
3+
4+
.. glossary::
5+
6+
24x7x365
7+
Use this phrase to describe continuous availability. Don't
8+
replace the *x*'s with slashes, hyphens, or the word *by*.
9+
10+
.. list-table::
11+
:widths: 50 50
12+
:header-rows: 1
13+
14+
* - Recommended
15+
-
16+
* - We deliver fantastic support — we are here to help,
17+
24x7x365.
18+
- We deliver fantastic support: 24 by 7 by 365.
19+

0 commit comments

Comments
 (0)