Updated documentation formatting

This commit is contained in:
Simon Willison 2020-03-21 18:31:49 -07:00
commit 3d656f4b31
5 changed files with 8 additions and 0 deletions

View file

@ -7,6 +7,7 @@ Usage: datasette package [OPTIONS] FILES...
Options: Options:
-t, --tag TEXT Name for the resulting Docker container, can optionally use -t, --tag TEXT Name for the resulting Docker container, can optionally use
name:tag format name:tag format
-m, --metadata FILENAME Path to JSON file containing metadata to publish -m, --metadata FILENAME Path to JSON file containing metadata to publish
--extra-options TEXT Extra options to pass to datasette serve --extra-options TEXT Extra options to pass to datasette serve
--branch TEXT Install datasette from a GitHub branch e.g. master --branch TEXT Install datasette from a GitHub branch e.g. master

View file

@ -13,6 +13,7 @@ Options:
--plugin-secret <TEXT TEXT TEXT>... --plugin-secret <TEXT TEXT TEXT>...
Secrets to pass to plugins, e.g. --plugin-secret Secrets to pass to plugins, e.g. --plugin-secret
datasette-auth-github client_id xxx datasette-auth-github client_id xxx
--version-note TEXT Additional note to show on /-/versions --version-note TEXT Additional note to show on /-/versions
--title TEXT Title for metadata --title TEXT Title for metadata
--license TEXT License label for metadata --license TEXT License label for metadata

View file

@ -13,6 +13,7 @@ Options:
--plugin-secret <TEXT TEXT TEXT>... --plugin-secret <TEXT TEXT TEXT>...
Secrets to pass to plugins, e.g. --plugin-secret Secrets to pass to plugins, e.g. --plugin-secret
datasette-auth-github client_id xxx datasette-auth-github client_id xxx
--version-note TEXT Additional note to show on /-/versions --version-note TEXT Additional note to show on /-/versions
--title TEXT Title for metadata --title TEXT Title for metadata
--license TEXT License label for metadata --license TEXT License label for metadata

View file

@ -13,6 +13,7 @@ Options:
--plugin-secret <TEXT TEXT TEXT>... --plugin-secret <TEXT TEXT TEXT>...
Secrets to pass to plugins, e.g. --plugin-secret Secrets to pass to plugins, e.g. --plugin-secret
datasette-auth-github client_id xxx datasette-auth-github client_id xxx
--version-note TEXT Additional note to show on /-/versions --version-note TEXT Additional note to show on /-/versions
--title TEXT Title for metadata --title TEXT Title for metadata
--license TEXT License label for metadata --license TEXT License label for metadata

View file

@ -10,11 +10,14 @@ Options:
connections from the local machine will be allowed. Use connections from the local machine will be allowed. Use
0.0.0.0 to listen to all IPs and allow access from other 0.0.0.0 to listen to all IPs and allow access from other
machines. machines.
-p, --port INTEGER Port for server, defaults to 8001. Use -p 0 to automatically -p, --port INTEGER Port for server, defaults to 8001. Use -p 0 to automatically
assign an available port. assign an available port.
--debug Enable debug mode - useful for development --debug Enable debug mode - useful for development
--reload Automatically reload if database or code change detected - --reload Automatically reload if database or code change detected -
useful for development useful for development
--cors Enable CORS by serving Access-Control-Allow-Origin: * --cors Enable CORS by serving Access-Control-Allow-Origin: *
--load-extension PATH Path to a SQLite extension to load --load-extension PATH Path to a SQLite extension to load
--inspect-file TEXT Path to JSON file created using "datasette inspect" --inspect-file TEXT Path to JSON file created using "datasette inspect"
@ -25,6 +28,7 @@ Options:
--memory Make :memory: database available --memory Make :memory: database available
--config CONFIG Set config option using configname:value --config CONFIG Set config option using configname:value
datasette.readthedocs.io/en/latest/config.html datasette.readthedocs.io/en/latest/config.html
--version-note TEXT Additional note to show on /-/versions --version-note TEXT Additional note to show on /-/versions
--help-config Show available config options --help-config Show available config options
--help Show this message and exit. --help Show this message and exit.