diff options
| author | milde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> | 2022-03-03 22:14:41 +0000 |
|---|---|---|
| committer | milde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> | 2022-03-03 22:14:41 +0000 |
| commit | f4062567a7d2c40e2aa0a799574c919c9ebb1eac (patch) | |
| tree | 73a08c0926aff26f9016d336fb9a69c023ef05b1 /docutils/docs/api | |
| parent | 211d42c8f0a2a5b83f8ee46ecddc7f28584ac138 (diff) | |
| download | docutils-f4062567a7d2c40e2aa0a799574c919c9ebb1eac.tar.gz | |
Documentation fixes/clarifications.
git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9014 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docutils/docs/api')
| -rw-r--r-- | docutils/docs/api/publisher.txt | 4 | ||||
| -rw-r--r-- | docutils/docs/api/runtime-settings.txt | 15 |
2 files changed, 7 insertions, 12 deletions
diff --git a/docutils/docs/api/publisher.txt b/docutils/docs/api/publisher.txt index 1d6ad5287..e6595cb9c 100644 --- a/docutils/docs/api/publisher.txt +++ b/docutils/docs/api/publisher.txt @@ -85,11 +85,11 @@ a dictionary of setting names & values, like this:: Settings from command-line options override configuration file settings, and they override application defaults. For details, see -`Docutils Runtime Settings`_. See `Docutils Configuration Files`_ for +`Docutils Runtime Settings`_. See `Docutils Configuration`_ for details about individual settings. .. _Docutils Runtime Settings: ./runtime-settings.html -.. _Docutils Configuration Files: ../user/tools.html +.. _Docutils Configuration: ../user/config.html Encodings diff --git a/docutils/docs/api/runtime-settings.txt b/docutils/docs/api/runtime-settings.txt index eee112bce..7bfab71d0 100644 --- a/docutils/docs/api/runtime-settings.txt +++ b/docutils/docs/api/runtime-settings.txt @@ -17,7 +17,6 @@ Introduction Docutils runtime settings are assembled from several sources: * Settings specifications of the selected components_, -* `application settings specifications`_, * `configuration files`_ (if enabled), and * command-line options (if enabled). @@ -50,14 +49,10 @@ overwrite earlier ones): __ `settings_overrides parameter`_ 4. Settings specified in `active sections`_ of the `configuration files`_ - in the order described in `Configuration File Sections & Entries`_. + in the order described in `Configuration File Sections & Entries`_ + (if enabled). -5. Command line arguments. - - -7. Settings specified in the `settings parameter`_ of the `convenience - functions`_ or the `settings` attribute of the ``Publisher.settings`` - attribute. +5. Command line options (if enabled). For details see the ``docutils/__init__.py``, ``docutils/core.py``, and ``docutils.frontend.py`` modules and the implementation description in @@ -146,7 +141,6 @@ the `settings_spec parameter`_ in application settings specifications are treated as components as well. -.. _application settings specifications: .. _convenience function: convenience functions @@ -154,7 +148,8 @@ convenience functions Applications usually deploy Docutils by one of the `Publisher convenience functions`_. -All convenience functions accept the following optional **parameters**: + +All convenience functions accept the following optional parameters: .. _settings parameter: |