Skip to content

Commit eb0c097

Browse files
committed
update source documentation
1 parent c7e7f8a commit eb0c097

File tree

4 files changed

+5
-4
lines changed

4 files changed

+5
-4
lines changed

docs/source/conf.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,8 @@
3737
'sphinx.ext.ifconfig',
3838
'sphinx.ext.viewcode',
3939
'sphinx.ext.napoleon',
40-
'sphinx.ext.intersphinx']
40+
'sphinx.ext.intersphinx',
41+
'sphinx.ext.autosectionlabel',]
4142

4243
intersphinx_mapping = {
4344
'python': ('https://docs.python.org/', None),

docs/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ The Github repository is located `here <https://github.com/FunctionLab/selene>`_
1616

1717
overview/overview
1818
overview/installation
19-
overview/tutorials
2019
overview/cli
20+
overview/tutorials
2121
overview/faq
2222

2323
.. toctree::

docs/source/overview/cli.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Selene CLI operations and outputs
33
=================================
44

5-
Selene provides a command-line interface (CLI) that takes in a user-specified configuration file containing the operations the user wants to run and the parameters required for these operations. It is automatically installed using a setuptools entrypoint so it can be called with the bash function ``selene_sdk`` from anywhere in the bash. It can also be called with ``python -m selene_sdk``. See :ref:`Operations` for more detail.
5+
Selene provides a command-line interface (CLI) that takes in a user-specified configuration file containing the operations the user wants to run and the parameters required for these operations. It is automatically installed using a setuptools entrypoint so it can be called with ``python -m selene_sdk``.
66

77
The sections that follow describe in detail how the various components that make up the configuration file are specified. For operation-specific sections (e.g. training, evaluation), we also explain what the expected outputs are.
88

docs/source/overview/installation.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,4 +58,4 @@ Additional dependency for running the CLI (versions 0.4.8 and below)
5858
--------------------------------------------------------------------
5959

6060
Please install ``docopt`` before running the command-line script ``selene_cli.py`` provided in the repository.
61-
In newer versions of Selene, the CLI can be run by calling ``selene_sdk`` or ``python -m selene_sdk`` from anywhere in bash (assuming you have installed the library, through conda/pip/local install - ``python setup.py install``).
61+
In newer versions of Selene, the CLI can be run by calling ``python -m selene_sdk`` from anywhere in bash (assuming you have installed the library, through conda/pip/local install - ``python setup.py install``).

0 commit comments

Comments
 (0)