Skip to content

Commit

Permalink
Commit for v3.0.0rc4
Browse files Browse the repository at this point in the history
  • Loading branch information
d0c-s4vage committed Feb 1, 2023
1 parent 4f99f06 commit 43f2199
Show file tree
Hide file tree
Showing 6 changed files with 44 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ def read_file(*parts):


# The full version, including alpha/beta/rc tags
release = os.environ.get("READTHEDOCS_VERSION", '{{VERSION}}')
release = os.environ.get("READTHEDOCS_VERSION", '3.0.0rc4')


# -- General configuration ---------------------------------------------------
Expand Down
40 changes: 39 additions & 1 deletion docs/source/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,45 @@ The ``lookatme`` CLI has a few options to control it's behavior:

.. code-block:: text
{{LOOKATME_HELP_OUTPUT_INDENTED}}
Usage: python -m lookatme [OPTIONS] [INPUT_FILES]...
lookatme - An interactive, terminal-based markdown presentation tool.
See https://lookatme.readthedocs.io/en/v3.0.0rc4 for documentation
Options:
--debug
--threads
-l, --log PATH
--tutorial TEXT As a flag: show all tutorials. With a
value/comma-separated values: show the
specific tutorials. Use the value 'help' for
more help
-t, --theme [dark|light]
--dump-styles Dump the resolved styles that will be used
with the presentation to stdout
--live, --live-reload Watch the input filename for modifications and
automatically reload
-s, --safe Do not load any new extensions specified in
the source markdown. Extensions specified via
env var or -e are still loaded
--no-ext-warn Load new extensions specified in the source
markdown without warning
-i, --ignore-ext-failure Ignore load failures of extensions
-e, --exts TEXT A comma-separated list of extension names to
automatically load (LOOKATME_EXTS)
--single, --one Render the source as a single slide
-f, --format [html|html_raw] The output format to convert the markdown to.
See also --output and --opt. Install lookatme
extras for additional output formats:
lookatme[gif]
-o, --output OUTPUT_PATH Output the markdown slides in a specific
--format to this path
--opt OPTION Provide a specific option for the output
format in the form key=value. Use 'help' or
'list' to see all output options.
--version Show the version and exit.
--help Show this message and exit.
``--live`` / ``--live-reload``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down
2 changes: 1 addition & 1 deletion lookatme/__init__.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
VERSION = __version__ = "{{VERSION}}"
VERSION = __version__ = "3.0.0rc4"
2 changes: 1 addition & 1 deletion lookatme/__main__.py
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ def main(
):
"""lookatme - An interactive, terminal-based markdown presentation tool.
See https://lookatme.readthedocs.io/en/v{{VERSION}} for documentation
See https://lookatme.readthedocs.io/en/v3.0.0rc4 for documentation
"""
lookatme.config.LOG = lookatme.log.create_log(log_path)
if debug:
Expand Down
2 changes: 1 addition & 1 deletion lookatme/tutorial.py
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ def _get_source_link(self):
_, lineno = inspect.getsourcelines(self.impl_fn)

version = "v" + lookatme.VERSION
if version == "v{{VERSION}}":
if version == "v3.0.0rc4":
version = "main"

return "[{module}.{fn_name}]({link})".format(
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ def extra_requirements() -> Dict:

setup(
name="lookatme",
version="{{VERSION}}",
version="3.0.0rc4",
description="An interactive, command-line presentation tool",
author="James Johnson",
author_email="d0c.s4vage@gmail.com",
Expand Down

0 comments on commit 43f2199

Please sign in to comment.