Update docs

thombashi · Sep 9, 2018 · 7459936 · 7459936
1 parent 22221d9
commit 7459936
Show file tree

Hide file tree

Showing 7 changed files with 20 additions and 10 deletions.
diff --git a/docs/make_readme.py b/docs/make_readme.py
@@ -26,7 +26,11 @@ def write_examples(maker):
     maker.inc_indent_level()
     maker.write_chapter("Create SQLite database from files")
 
-    maker.write_line_list([".. image:: https://cdn.rawgit.com/thombashi/sqlitebiter/master/docs/svg/usage_example.svg"])
+    maker.write_line_list(
+        [
+            ".. image:: https://cdn.rawgit.com/thombashi/sqlitebiter/master/docs/svg/usage_example.svg"
+        ]
+    )
 
     maker.write_chapter("Create SQLite database from URL")
     maker.write_file(usage_root.joinpath("url", "usage.txt"))

diff --git a/docs/pages/installation.rst b/docs/pages/installation.rst
@@ -94,9 +94,9 @@ Following mandatory Python packages are automatically installed during
 - `appconfigpy <https://github.com/thombashi/appconfigpy>`__
 - `click <http://click.pocoo.org/>`__
 - `colorama <https://github.com/tartley/colorama>`__
-- `logbook <http://logbook.readthedocs.io/en/stable/>`__
+- `logbook <https://logbook.readthedocs.io/en/stable/>`__
 - `msgfy <https://github.com/thombashi/msgfy>`__
-- `nbformat <http://jupyter.org/>`__
+- `nbformat <https://jupyter.org/>`__
 - `path.py <https://github.com/jaraco/path.py>`__
 - `pathvalidate <https://github.com/thombashi/pathvalidate>`__
 - `pytablereader <https://github.com/thombashi/pytablereader>`__
@@ -123,19 +123,19 @@ The above packages can be installed with the following pip command;
 Test dependencies
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 - `pytablewriter <https://github.com/thombashi/pytablewriter>`__
-- `pytest <http://pytest.org/latest/>`__
+- `pytest <https://docs.pytest.org/en/latest/>`__
 - `pytest-runner <https://pypi.python.org/pypi/pytest-runner>`__
 - `responses <https://github.com/getsentry/responses>`__
 - `tox <https://testrun.org/tox/latest/>`__
 
 Misc dependencies (Optional)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-- `lxml <http://lxml.de/installation.html>`__
+- `lxml <https://lxml.de/installation.html>`__
 - `pypandoc <https://github.com/bebraw/pypandoc>`__
     - required when converting MediaWiki files
 
 
 Dependencies other than Python packages (Optional)
 ------------------------------------------------------------
 - ``libxml2`` (faster HTML/Markdown conversion)
-- `pandoc <http://pandoc.org/>`__ (required when converting MediaWiki files)
+- `pandoc <https://pandoc.org/>`__ (required when converting MediaWiki files)
diff --git a/docs/pages/introduction/feature.txt b/docs/pages/introduction/feature.txt
@@ -6,7 +6,7 @@ Features
         - Microsoft Excel :superscript:`TM`
         - HTML
         - JSON
-        - `Jupyter Notebook <http://jupyter.org/>`__
+        - `Jupyter Notebook <https://jupyter.org/>`__
         - `Labeled Tab-separated Values (LTSV) <http://ltsv.org/>`__
         - `Line-delimited JSON(LDJSON) <https://en.wikipedia.org/wiki/JSON_streaming#Line-delimited_JSON>`__/NDJSON/JSON Lines
         - Markdown

diff --git a/docs/pages/usage/file/help.txt b/docs/pages/usage/file/help.txt
@@ -10,12 +10,17 @@
       database file.
 
     Options:
+      -r, --recursive                 Read all files under each directory,
+                                      recursively.
+      --pattern PATTERN               Convert files matching PATTERN.
+      --exclude PATTERN               Exclude files matching PATTERN.
+      --follow-symlinks               Follow symlinks.
       -f, --format [csv|excel|html|json|json_lines|jsonl|ldjson|ltsv|markdown|mediawiki|ndjson|sqlite|ssv|tsv|ipynb]
                                       Data format to loading (auto-detect from
                                       file extensions in default).
       --encoding ENCODING             Encoding to load files. Auto-detection from
                                       files in default.
       -h, --help                      Show this message and exit.
 
-      Documentation: http://sqlitebiter.rtfd.io/ Issue tracker:
+      Documentation: https://sqlitebiter.rtfd.io/ Issue tracker:
       https://github.com/thombashi/sqlitebiter/issues
diff --git a/docs/pages/usage/gs/help.txt b/docs/pages/usage/gs/help.txt
@@ -13,5 +13,5 @@
     Options:
       -h, --help  Show this message and exit.
 
-      Documentation: http://sqlitebiter.rtfd.io/ Issue tracker:
+      Documentation: https://sqlitebiter.rtfd.io/ Issue tracker:
       https://github.com/thombashi/sqlitebiter/issues
diff --git a/docs/pages/usage/url/help.txt b/docs/pages/usage/url/help.txt
@@ -15,5 +15,5 @@
                                       [user:passwd@]proxy.server:port.
       -h, --help                      Show this message and exit.
 
-      Documentation: http://sqlitebiter.rtfd.io/ Issue tracker:
+      Documentation: https://sqlitebiter.rtfd.io/ Issue tracker:
       https://github.com/thombashi/sqlitebiter/issues
diff --git a/docs/update_command_help.py b/docs/update_command_help.py
@@ -12,6 +12,7 @@
 
 from subprocrunner import SubprocessRunner
 
+
 env = dict(os.environ, LC_ALL="C.UTF-8")
 
 proc = SubprocessRunner("sqlitebiter -h")