mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
corrections for misspellings
This commit is contained in:
parent
2ba3e561b2
commit
8981b9bd13
@ -909,7 +909,7 @@ the `Dublin Core metadata <http://dublincore.org/>`_.
|
|||||||
the optional guide information. See the OPF documentation
|
the optional guide information. See the OPF documentation
|
||||||
at `<http://idpf.org/epub>`_ for details. If possible, default entries
|
at `<http://idpf.org/epub>`_ for details. If possible, default entries
|
||||||
for the *cover* and *toc* types are automatically inserted. However,
|
for the *cover* and *toc* types are automatically inserted. However,
|
||||||
the types can be explicitely overwritten if the default entries are not
|
the types can be explicitly overwritten if the default entries are not
|
||||||
appropriate. Example::
|
appropriate. Example::
|
||||||
|
|
||||||
epub_guide = (('cover', 'cover.html', u'Cover Page'),)
|
epub_guide = (('cover', 'cover.html', u'Cover Page'),)
|
||||||
@ -949,8 +949,8 @@ the `Dublin Core metadata <http://dublincore.org/>`_.
|
|||||||
.. confval:: epub_tocdup
|
.. confval:: epub_tocdup
|
||||||
|
|
||||||
This flag determines if a toc entry is inserted again at the beginning of
|
This flag determines if a toc entry is inserted again at the beginning of
|
||||||
it's nested toc listing. This allows easier navitation to the top of
|
it's nested toc listing. This allows easier navigation to the top of
|
||||||
a chapter, but can be confusing because it mixes entries of differnet
|
a chapter, but can be confusing because it mixes entries of different
|
||||||
depth in one list. The default value is ``True``.
|
depth in one list. The default value is ``True``.
|
||||||
|
|
||||||
.. confval:: epub_tocscope
|
.. confval:: epub_tocscope
|
||||||
@ -1146,8 +1146,8 @@ These options influence LaTeX output.
|
|||||||
Additional preamble content, default empty.
|
Additional preamble content, default empty.
|
||||||
``'figure_align'``
|
``'figure_align'``
|
||||||
Latex figure float alignment, default 'htbp' (here, top, bottom, page).
|
Latex figure float alignment, default 'htbp' (here, top, bottom, page).
|
||||||
Whenever an image doesn't fit into the current page, it wil be
|
Whenever an image doesn't fit into the current page, it will be
|
||||||
'floated' into the next page but may be preceeded by any other text.
|
'floated' into the next page but may be preceded by any other text.
|
||||||
If you don't like this behavior, use 'H' which will disable floating
|
If you don't like this behavior, use 'H' which will disable floating
|
||||||
and position figures strictly in the order they appear in the source.
|
and position figures strictly in the order they appear in the source.
|
||||||
``'footer'``
|
``'footer'``
|
||||||
@ -1415,7 +1415,6 @@ These options influence Texinfo output.
|
|||||||
``'project'``
|
``'project'``
|
||||||
``'release'``
|
``'release'``
|
||||||
``'title'``
|
``'title'``
|
||||||
``'direntry'``
|
|
||||||
|
|
||||||
.. versionadded:: 1.1
|
.. versionadded:: 1.1
|
||||||
|
|
||||||
|
@ -245,11 +245,11 @@ Debugging Tips
|
|||||||
<http://docutils.sourceforge.net/docs/user/config.html>`_.
|
<http://docutils.sourceforge.net/docs/user/config.html>`_.
|
||||||
|
|
||||||
* JavaScript stemming algorithms in `sphinx/search/*.py` (except `en.py`) are
|
* JavaScript stemming algorithms in `sphinx/search/*.py` (except `en.py`) are
|
||||||
genereted by
|
generated by this
|
||||||
`modified snowballcode generator <https://github.com/shibukawa/snowball>`_.
|
`modified snowballcode generator <https://github.com/shibukawa/snowball>`_.
|
||||||
Generated `JSX <http://jsx.github.io/>`_ files are
|
Generated `JSX <http://jsx.github.io/>`_ files are
|
||||||
in `this repository <https://github.com/shibukawa/snowball-stemmer.jsx>`_.
|
in `this repository <https://github.com/shibukawa/snowball-stemmer.jsx>`_.
|
||||||
You can get resulting JavaScript files by the following command:
|
You can get the resulting JavaScript files using the following command:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
|
@ -88,7 +88,7 @@ linking:
|
|||||||
|
|
||||||
This will download the corresponding :file:`objects.inv` file from the
|
This will download the corresponding :file:`objects.inv` file from the
|
||||||
Internet and generate links to the pages under the given URI. The downloaded
|
Internet and generate links to the pages under the given URI. The downloaded
|
||||||
inventory is cached in the Sphinx environment, so it must be redownloaded
|
inventory is cached in the Sphinx environment, so it must be re-downloaded
|
||||||
whenever you do a full rebuild.
|
whenever you do a full rebuild.
|
||||||
|
|
||||||
A second example, showing the meaning of a non-``None`` value of the second
|
A second example, showing the meaning of a non-``None`` value of the second
|
||||||
|
@ -197,7 +197,7 @@ Sphinx.
|
|||||||
|
|
||||||
The default is the ``http://`` URL that loads the JS files from the `MathJax
|
The default is the ``http://`` URL that loads the JS files from the `MathJax
|
||||||
CDN <http://docs.mathjax.org/en/latest/start.html>`_. If you want MathJax to
|
CDN <http://docs.mathjax.org/en/latest/start.html>`_. If you want MathJax to
|
||||||
be available offline, you have to donwload it and set this value to a
|
be available offline, you have to download it and set this value to a
|
||||||
different path.
|
different path.
|
||||||
|
|
||||||
The path can be absolute or relative; if it is relative, it is relative to
|
The path can be absolute or relative; if it is relative, it is relative to
|
||||||
|
@ -285,7 +285,7 @@ There is `sphinx translation page`_ for Sphinx-1.2 documentation.
|
|||||||
|
|
||||||
.. rubric:: Footnotes
|
.. rubric:: Footnotes
|
||||||
|
|
||||||
.. [1] See the `GNU gettext utilites
|
.. [1] See the `GNU gettext utilities
|
||||||
<http://www.gnu.org/software/gettext/manual/gettext.html#Introduction>`_
|
<http://www.gnu.org/software/gettext/manual/gettext.html#Introduction>`_
|
||||||
for details on that software suite.
|
for details on that software suite.
|
||||||
.. [2] Because nobody expects the Spanish Inquisition!
|
.. [2] Because nobody expects the Spanish Inquisition!
|
||||||
|
@ -235,7 +235,7 @@ These themes are:
|
|||||||
- **relbar1** (true or false, default true): If this is true, the
|
- **relbar1** (true or false, default true): If this is true, the
|
||||||
`relbar1` block is inserted in the epub output, otherwise it is omitted.
|
`relbar1` block is inserted in the epub output, otherwise it is omitted.
|
||||||
- **footer** (true or false, default true): If this is true, the
|
- **footer** (true or false, default true): If this is true, the
|
||||||
`footer` block is inserted in the epub output, otherwise it is ommitted.
|
`footer` block is inserted in the epub output, otherwise it is omitted.
|
||||||
|
|
||||||
Creating themes
|
Creating themes
|
||||||
---------------
|
---------------
|
||||||
|
@ -300,7 +300,7 @@ More topics to be covered
|
|||||||
|
|
||||||
.. rubric:: Footnotes
|
.. rubric:: Footnotes
|
||||||
|
|
||||||
.. [#] This is the usual lay-out. However, :file:`conf.py` can also live in
|
.. [#] This is the usual layout. However, :file:`conf.py` can also live in
|
||||||
another directory, the :term:`configuration directory`. See
|
another directory, the :term:`configuration directory`. See
|
||||||
:ref:`invocation`.
|
:ref:`invocation`.
|
||||||
|
|
||||||
|
@ -109,7 +109,7 @@ must update the websupport package's data::
|
|||||||
support.update_username(old_username, new_username)
|
support.update_username(old_username, new_username)
|
||||||
|
|
||||||
*username* should be a unique string which identifies a user, and *moderator*
|
*username* should be a unique string which identifies a user, and *moderator*
|
||||||
should be a boolean representing whether the user has moderation privilieges.
|
should be a boolean representing whether the user has moderation privileges.
|
||||||
The default value for *moderator* is *False*.
|
The default value for *moderator* is *False*.
|
||||||
|
|
||||||
An example `Flask <http://flask.pocoo.org/>`_ function that checks whether a
|
An example `Flask <http://flask.pocoo.org/>`_ function that checks whether a
|
||||||
|
Loading…
Reference in New Issue
Block a user