Browse Source

Disable smartypants option

This commit disables the smartypants option of the document. We don't
need to convert quotes and dashes. And this commit also quotes the
--database-connection option. This should be better for the command
option description.

Change-Id: I79d3294eedf16085fa8c84d0ba203024cf80c181
Masayuki Igawa 1 year ago
parent
commit
c2324a7d22
No account linked to committer's email address
2 changed files with 5 additions and 1 deletions
  1. 1
    1
      README.rst
  2. 4
    0
      doc/source/conf.py

+ 1
- 1
README.rst View File

@@ -56,7 +56,7 @@ There are several options for running coverage2sql, they can be listed with::
56 56
 
57 57
     coverage2sql --help
58 58
 
59
-The only required option is --database-connection. The options can either be
59
+The only required option is ``--database-connection``. The options can either be
60 60
 used on the CLI, or put in a config file. If a config file is used you need to
61 61
 specify the location on the CLI.
62 62
 

+ 4
- 0
doc/source/conf.py View File

@@ -75,3 +75,7 @@ latex_documents = [
75 75
 
76 76
 # Example configuration for intersphinx: refer to the Python standard library.
77 77
 #intersphinx_mapping = {'http://docs.python.org/': None}
78
+
79
+# If true, SmartyPants will be used to convert quotes and dashes to
80
+# typographically correct entities.
81
+html_use_smartypants = False

Loading…
Cancel
Save