1. coady
  2. lupyne


coady  committed 9f981ba

Insert help output into documentation.

  • Participants
  • Parent commits f4e8985
  • Branches default

Comments (0)

Files changed (2)

File docs/conf.py

View file
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage', 'sphinx.ext.viewcode']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage', 'sphinx.ext.viewcode', 'sphinxcontrib.programoutput']
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

File docs/server.rst

View file
-Usage: python -m lupyne.server [index_directory ...]
-  -h, --help            show this help message and exit
-  -r, --read-only       expose only read methods; no write lock
-  -c CONFIG, --config=CONFIG
-                        optional configuration file or json object of global
-                        params
-  -p FILE, --pidfile=FILE
-                        store the process id in the given file
-  -d, --daemonize       run the server as a daemon
-  --autoreload=SECONDS  automatically reload modules; replacement for
-                        engine.autoreload
-  --autoupdate=SECONDS  automatically update index version and commit any
-                        changes
-  --autosync=HOSTS
-                        automatically synchronize searcher with remote hosts
-                        and update
-  --real-time           search in real-time without committing
+.. program-output:: python -m lupyne.server -h
+  :cwd: ..
 .. automodule:: lupyne.server
 .. note:: Lucene doc ids are ephemeral;  only use doc ids across requests for the same index version.