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.
88You should put this file in the current working directory where you execute
99the tool. Generally speaking, this is the root of your project.
1010
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
1212keep them under version control. Not all options available in the configuration
1313are available on the command line. Such as the :ref: `extension configuration `.
1414
Original file line number Diff line number Diff line change @@ -12,7 +12,7 @@ Create your first documentation
1212===============================
1313
1414After :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.
1616
1717.. code-block :: rst
1818
@@ -49,6 +49,6 @@ to learn more about the configuration.
4949Extending
5050=========
5151
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
5454shown 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
2222formats.
2323
2424Besides 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
2626and how to use the libraries.
2727
2828If 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
2727
2828 vendor/bin/guides ./docs
2929
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
3131recommended way to get started. You can learn more about how to extend the commandline tool in the :doc: `/cli/index ` section.
3232
3333Library (advanced)
34- ===============================
34+ ==================
3535
3636.. _library :
3737
Original file line number Diff line number Diff line change @@ -7,7 +7,7 @@ Admonitions
77===========
88
99Admonitions 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.
1111
1212.. index :: reST directives; seealso
1313
You can’t perform that action at this time.
0 commit comments