Skip to content

Commit

Permalink
troubleshoot read-the-docs build failure (#1155)
Browse files Browse the repository at this point in the history
troubleshoot render
  • Loading branch information
ddkohler committed Feb 21, 2024
1 parent 3c03f8e commit cb21900
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
14 changes: 7 additions & 7 deletions docs/cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ Command Line Interface (CLI)

Most of the CLI interface is new as of v3.5.2 and under active depelopment.
The commands here may change.
Currently, there are two supported CLI calls to use: `wt-convert`, and `wt5`.
For usage hints, use the `--help` argument.
Currently, there are two supported CLI calls to use: ``wt-convert``, and ``wt5``.
For usage hints, use the ``--help`` argument.

wt-convert
----------

Use `wt-convert`` to explore the WrightTools units system and the conversions of units.
Use ``wt-convert`` to explore the WrightTools units system and the conversions of units.

.. code-block:: shell
> wt-units 1330 nm wn
Expand All @@ -27,15 +27,15 @@ wt5

The wt5 command is meant to provide easy access to wt5 files and some basic wt5 properties.

Use `wt5 glob` to quickly probe a folder for wt5s contained inside
Use ``wt5 glob`` to quickly probe a folder for wt5s contained inside
.. code-block:: shell
> wt5 glob -d path/to/datasets
tests\dataset\max_cached.wt5
WrightTools\datasets\wt5\v1.0.0\perovskite_TA.wt5
WrightTools\datasets\wt5\v1.0.1\MoS2_TrEE_movie.wt5
Use `wt5 explore` to see details of wt5s within a folder, as the option of quick load a wt5.
Use ``wt5 explore`` to see details of wt5s within a folder, as the option of quick load a wt5.
.. code-block:: shell
> wt5 explore -d path/to/data/folders
Expand All @@ -50,7 +50,7 @@ Use `wt5 explore` to see details of wt5s within a folder, as the option of quick
Specify an index to load that entry. Use `t` to rerender table. Use no argument to exit.
"
Use `wt5 load` to quickly open an interactive python console with your wt5 data pre-loaded.
Use ``wt5 load`` to quickly open an interactive python console with your wt5 data pre-loaded.
.. code-block:: shell
> wt5 load path\to\data_file.wt5
--- INTERACTING --- (to continue, call exit() or quit())
Expand All @@ -60,7 +60,7 @@ Use `wt5 load` to quickly open an interactive python console with your wt5 data
>>>
Use `wt5 tree` to see a quick tree structure of a wt5 file.
Use ``wt5 tree`` to see a quick tree structure of a wt5 file.
.. code-block:: shell
> wt5 tree path\to\data
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@

# General information about the project.
project = "WrightTools"
copyright = "2016-2019, WrightTools Developers"
copyright = "2016-2024, WrightTools Developers"
author = "WrightTools Developers"

# The version info for the project you're documenting, acts as replacement for
Expand Down

0 comments on commit cb21900

Please sign in to comment.