File tree Expand file tree Collapse file tree 5 files changed +8
-8
lines changed
reference/restructuredtext Expand file tree Collapse file tree 5 files changed +8
-8
lines changed Original file line number Diff line number Diff line change @@ -8,7 +8,7 @@ The cli tool is able to read configuration from a ``guides.xml`` file.
8
8
You should put this file in the current working directory where you execute
9
9
the tool. Generally speaking, this is the root of your project.
10
10
11
- Using a configuration file allows you to set project specific settings and
11
+ Using a configuration file allows you to set project- specific settings and
12
12
keep them under version control. Not all options available in the configuration
13
13
are available on the command line. Such as the :ref: `extension configuration `.
14
14
Original file line number Diff line number Diff line change @@ -12,7 +12,7 @@ Create your first documentation
12
12
===============================
13
13
14
14
After :doc: `/installation ` you can directly start to create your first documentation.
15
- to do this create a new directory named ``docs `` and create a file called ``index.rst `` in it.
15
+ to do this, create a new directory named ``docs `` and create a file called ``index.rst `` in it.
16
16
17
17
.. code-block :: rst
18
18
@@ -49,6 +49,6 @@ to learn more about the configuration.
49
49
Extending
50
50
=========
51
51
52
- Like any other component in this repository the commandline tool can be extended. This can
53
- be done using an extension class. And reference this class in the configuration file. Like
52
+ Like any other component in this repository, the commandline tool can be extended. This can
53
+ be done using an extension class, and referencing this class in the configuration file, like
54
54
shown for in the :ref: `.extension-configuration ` section.
Original file line number Diff line number Diff line change @@ -22,7 +22,7 @@ your documentation from `reStructuredText Markup <https://docutils.sourceforge.i
22
22
formats.
23
23
24
24
Besides the commandline tool it also provides a number of libraries that can be used to build your own application
25
- to render the supported formats. To any format you want. On these pages is explained how to use the commandline tool
25
+ to render the supported formats, to any format you want. On these pages is explained how to use the commandline tool
26
26
and how to use the libraries.
27
27
28
28
If you are looking for a complete solution to create a documentation website then you may want to look at
Original file line number Diff line number Diff line change @@ -27,11 +27,11 @@ This will install the commandline tool in the vendor/bin directory. You can then
27
27
28
28
vendor/bin/guides ./docs
29
29
30
- The commandline tool is build for extension, if you do not have special needs this is the
30
+ The commandline tool is built for extension, if you do not have special needs this is the
31
31
recommended way to get started. You can learn more about how to extend the commandline tool in the :doc: `/cli/index ` section.
32
32
33
33
Library (advanced)
34
- ===============================
34
+ ==================
35
35
36
36
.. _library :
37
37
Original file line number Diff line number Diff line change @@ -7,7 +7,7 @@ Admonitions
7
7
===========
8
8
9
9
Admonitions are blocks of text that are rendered in a special way to draw attention to them. They are often used to
10
- provide additional information to the reader about the content that is being discussed. t6est
10
+ provide additional information to the reader about the content that is being discussed.
11
11
12
12
.. index :: reST directives; seealso
13
13
You can’t perform that action at this time.
0 commit comments