Skip to content

Commit

Permalink
simplify and improve documentation markup (#742)
Browse files Browse the repository at this point in the history
- use | to get a more "compact" representation
- link directly to example config files
  • Loading branch information
mikf committed May 12, 2020
1 parent 4cc761c commit be16d77
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions docs/configuration.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
Configuration
#############

Configuration files for *gallery-dl* use a JSON-based file format.

For a (more or less) complete example with options set to their default values, see gallery-dl.conf_.

For a configuration file example with more involved settings and options, see gallery-dl-example.conf_.
| Configuration files for *gallery-dl* use a JSON-based file format.
| For a (more or less) complete example with options set to their default values,
see `gallery-dl.conf <gallery-dl.conf>`__.
| For a configuration file example with more involved settings and options,
see `gallery-dl-example.conf <gallery-dl-example.conf>`__.
This file lists all available configuration options and their descriptions.

Expand Down Expand Up @@ -2160,8 +2160,6 @@ Description An object with the ``name`` of a post-processor and its options.
.. _date-format: `extractor.*.date-format`_
.. _deviantart.metadata: extractor.deviantart.metadata_

.. _gallery-dl.conf: https://github.com/mikf/gallery-dl/blob/master/docs/gallery-dl.conf
.. _gallery-dl-example.conf: https://github.com/mikf/gallery-dl/blob/master/docs/gallery-dl-example.conf
.. _.netrc: https://stackoverflow.com/tags/.netrc/info
.. _Last-Modified: https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.29
.. _datetime: https://docs.python.org/3/library/datetime.html#datetime-objects
Expand Down

0 comments on commit be16d77

Please sign in to comment.