mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
more corrections for spelling and grammar
This commit is contained in:
parent
00feeb154c
commit
4883e1eba2
6
CHANGES
6
CHANGES
@ -535,7 +535,7 @@ Features added
|
||||
- The :confval:`latex_documents`, :confval:`texinfo_documents`, and
|
||||
:confval:`man_pages` configuration values will be set to default values based
|
||||
on the :confval:`master_doc` if not explicitly set in :file:`conf.py`.
|
||||
Previously, if these values were not set, no output would be genereted by
|
||||
Previously, if these values were not set, no output would be generated by
|
||||
their respective builders.
|
||||
|
||||
* Internationalization:
|
||||
@ -576,7 +576,7 @@ Features added
|
||||
- sphinx-build now provides more specific error messages when called with
|
||||
invalid options or arguments.
|
||||
- sphinx-build now has a verbose option :option:`-v` which can be repeated for
|
||||
greater effect. A single occurrance provides a slightly more verbose output
|
||||
greater effect. A single occurrence provides a slightly more verbose output
|
||||
than normal. Two or more occurrences of this option provides more detailed
|
||||
output which may be useful for debugging.
|
||||
|
||||
@ -1036,7 +1036,7 @@ Release 1.0.6 (Jan 04, 2011)
|
||||
* #515: Fix tracebacks in the viewcode extension for Python objects
|
||||
that do not have a valid signature.
|
||||
|
||||
* Fix strange reportings of line numbers for warnings generated from
|
||||
* Fix strange reports of line numbers for warnings generated from
|
||||
autodoc-included docstrings, due to different behavior depending
|
||||
on docutils version.
|
||||
|
||||
|
@ -321,7 +321,7 @@ Project information
|
||||
Options for internationalization
|
||||
--------------------------------
|
||||
|
||||
These options influence Sphinx' *Native Language Support*. See the
|
||||
These options influence Sphinx's *Native Language Support*. See the
|
||||
documentation on :ref:`intl` for details.
|
||||
|
||||
.. confval:: language
|
||||
@ -424,7 +424,7 @@ Options for HTML output
|
||||
-----------------------
|
||||
|
||||
These options influence HTML as well as HTML Help output, and other builders
|
||||
that use Sphinx' HTMLWriter class.
|
||||
that use Sphinx's HTMLWriter class.
|
||||
|
||||
.. confval:: html_theme
|
||||
|
||||
@ -452,14 +452,14 @@ that use Sphinx' HTMLWriter class.
|
||||
.. confval:: html_style
|
||||
|
||||
The style sheet to use for HTML pages. A file of that name must exist either
|
||||
in Sphinx' :file:`static/` path, or in one of the custom paths given in
|
||||
in Sphinx's :file:`static/` path, or in one of the custom paths given in
|
||||
:confval:`html_static_path`. Default is the stylesheet given by the selected
|
||||
theme. If you only want to add or override a few things compared to the
|
||||
theme's stylesheet, use CSS ``@import`` to import the theme's stylesheet.
|
||||
|
||||
.. confval:: html_title
|
||||
|
||||
The "title" for HTML documentation generated with Sphinx' own templates.
|
||||
The "title" for HTML documentation generated with Sphinx's own templates.
|
||||
This is appended to the ``<title>`` tag of individual pages, and used in the
|
||||
navigation bar as the "topmost" element. It defaults to :samp:`'{<project>}
|
||||
v{<revision>} documentation'` (with the values coming from the config
|
||||
@ -540,8 +540,9 @@ that use Sphinx' HTMLWriter class.
|
||||
|
||||
.. confval:: html_use_smartypants
|
||||
|
||||
If true, *SmartyPants* will be used to convert quotes and dashes to
|
||||
typographically correct entities. Default: ``True``.
|
||||
If true, `SmartyPants <http://daringfireball.net/projects/smartypants/>`_
|
||||
will be used to convert quotes and dashes to typographically correct
|
||||
entities. Default: ``True``.
|
||||
|
||||
.. confval:: html_add_permalinks
|
||||
|
||||
@ -701,7 +702,7 @@ that use Sphinx' HTMLWriter class.
|
||||
.. confval:: html_translator_class
|
||||
|
||||
A string with the fully-qualified name of a HTML Translator class, that is, a
|
||||
subclass of Sphinx' :class:`~sphinx.writers.html.HTMLTranslator`, that is
|
||||
subclass of Sphinx's :class:`~sphinx.writers.html.HTMLTranslator`, that is
|
||||
used to translate document trees to HTML. Default is ``None`` (use the
|
||||
builtin translator).
|
||||
|
||||
@ -768,7 +769,7 @@ that use Sphinx' HTMLWriter class.
|
||||
* ``sv`` -- Swedish
|
||||
* ``tr`` -- Turkish
|
||||
|
||||
.. admonition:: Accelerate build speed
|
||||
.. admonition:: Accelerating build speed
|
||||
|
||||
Each language (except Japanese) provides its own stemming algorithm.
|
||||
Sphinx uses a Python implementation by default. You can use a C
|
||||
@ -803,7 +804,7 @@ that use Sphinx' HTMLWriter class.
|
||||
|
||||
.. confval:: html_search_scorer
|
||||
|
||||
The name of a javascript file (relative to the configuration directory) that
|
||||
The name of a JavaScript file (relative to the configuration directory) that
|
||||
implements a search results scorer. If empty, the default will be used.
|
||||
|
||||
.. XXX describe interface for scorer here
|
||||
@ -1036,7 +1037,7 @@ These options influence LaTeX output.
|
||||
``'John \and Sarah'``.
|
||||
* *documentclass*: Normally, one of ``'manual'`` or ``'howto'`` (provided by
|
||||
Sphinx). Other document classes can be given, but they must include the
|
||||
"sphinx" package in order to define Sphinx' custom LaTeX commands. "howto"
|
||||
"sphinx" package in order to define Sphinx's custom LaTeX commands. "howto"
|
||||
documents will not get appendices. Also, howtos will have a simpler title
|
||||
page.
|
||||
|
||||
@ -1453,7 +1454,7 @@ Options for the linkcheck builder
|
||||
.. confval:: linkcheck_anchors
|
||||
|
||||
If true, check the validity of ``#anchor``\ s in links. Since this requires
|
||||
downloading the whole document, it's considerably slower when enabled.
|
||||
downloading the whole document, it's considerably slower when enabled.
|
||||
Default is ``True``.
|
||||
|
||||
.. versionadded:: 1.2
|
||||
|
@ -603,7 +603,7 @@ These roles link to the given object types:
|
||||
|
||||
.. note::
|
||||
|
||||
Sphinx' syntax to give references a custom title can interfere with
|
||||
Sphinx's syntax to give references a custom title can interfere with
|
||||
linking to template classes, if nothing follows the closing angle
|
||||
bracket, i.e. if the link looks like this: ``:cpp:class:`MyClass<T>```.
|
||||
This is interpreted as a link to ``T`` with a title of ``MyClass``.
|
||||
|
@ -12,7 +12,7 @@ Glossary
|
||||
use the builder builders that e.g. check for broken links in the
|
||||
documentation, or build coverage information.
|
||||
|
||||
See :ref:`builders` for an overview over Sphinx' built-in builders.
|
||||
See :ref:`builders` for an overview over Sphinx's built-in builders.
|
||||
|
||||
configuration directory
|
||||
The directory containing :file:`conf.py`. By default, this is the same as
|
||||
|
@ -312,7 +312,7 @@ Docutils supports the following directives:
|
||||
- :dudir:`default-role` (set a new default role)
|
||||
- :dudir:`role` (create a new role)
|
||||
|
||||
Since these are only per-file, better use Sphinx' facilities for setting the
|
||||
Since these are only per-file, better use Sphinx's facilities for setting the
|
||||
:confval:`default_role`.
|
||||
|
||||
Do *not* use the directives :dudir:`sectnum`, :dudir:`header` and
|
||||
|
@ -11,8 +11,8 @@ anyone having used Django will already be familiar with it. It also has
|
||||
excellent documentation for those who need to make themselves familiar with it.
|
||||
|
||||
|
||||
Do I need to use Sphinx' templates to produce HTML?
|
||||
---------------------------------------------------
|
||||
Do I need to use Sphinx's templates to produce HTML?
|
||||
----------------------------------------------------
|
||||
|
||||
No. You have several other options:
|
||||
|
||||
@ -50,7 +50,7 @@ A template contains **variables**, which are replaced with values when the
|
||||
template is evaluated, **tags**, which control the logic of the template and
|
||||
**blocks** which are used for template inheritance.
|
||||
|
||||
Sphinx' *basic* theme provides base templates with a couple of blocks it will
|
||||
Sphinx's *basic* theme provides base templates with a couple of blocks it will
|
||||
fill with data. These are located in the :file:`themes/basic` subdirectory of
|
||||
the Sphinx installation directory, and used by all builtin Sphinx themes.
|
||||
Templates with the same name in the :confval:`templates_path` override templates
|
||||
|
@ -138,7 +138,7 @@ an argument to see which targets are available.
|
||||
Documenting objects
|
||||
-------------------
|
||||
|
||||
One of Sphinx' main objectives is easy documentation of :dfn:`objects` (in a
|
||||
One of Sphinx's main objectives is easy documentation of :dfn:`objects` (in a
|
||||
very general sense) in any :dfn:`domain`. A domain is a collection of object
|
||||
types that belong together, complete with markup to create and reference
|
||||
descriptions of these objects.
|
||||
|
@ -56,8 +56,8 @@ This will return a dictionary containing the following items:
|
||||
* **sidebar**: The sidebar of the document as HTML
|
||||
* **relbar**: A div containing links to related documents
|
||||
* **title**: The title of the document
|
||||
* **css**: Links to css files used by Sphinx
|
||||
* **js**: Javascript containing comment options
|
||||
* **css**: Links to CSS files used by Sphinx
|
||||
* **js**: JavaScript containing comment options
|
||||
|
||||
This dict can then be used as context for templates. The goal is to be easy to
|
||||
integrate with your existing templating system. An example using `Jinja2
|
||||
@ -110,7 +110,7 @@ must update the websupport package's data::
|
||||
|
||||
*username* should be a unique string which identifies a user, and *moderator*
|
||||
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
|
||||
user is logged in and then retrieves a document is::
|
||||
|
Loading…
Reference in New Issue
Block a user