updated
parent
667aa11751
commit
1288415b47
|
@ -4,25 +4,6 @@ hetrixtools-freebsd
|
||||||
|
|
||||||
This is the documentation of **hetrixtools-freebsd**.
|
This is the documentation of **hetrixtools-freebsd**.
|
||||||
|
|
||||||
.. note::
|
|
||||||
|
|
||||||
This is the main page of your project's `Sphinx`_ documentation.
|
|
||||||
It is formatted in `reStructuredText`_. Add additional pages
|
|
||||||
by creating rst-files in ``docs`` and adding them to the `toctree`_ below.
|
|
||||||
Use then `references`_ in order to link them from this page, e.g.
|
|
||||||
:ref:`authors` and :ref:`changes`.
|
|
||||||
|
|
||||||
It is also possible to refer to the documentation of other Python packages
|
|
||||||
with the `Python domain syntax`_. By default you can reference the
|
|
||||||
documentation of `Sphinx`_, `Python`_, `NumPy`_, `SciPy`_, `matplotlib`_,
|
|
||||||
`Pandas`_, `Scikit-Learn`_. You can add more by extending the
|
|
||||||
``intersphinx_mapping`` in your Sphinx's ``conf.py``.
|
|
||||||
|
|
||||||
The pretty useful extension `autodoc`_ is activated by default and lets
|
|
||||||
you include documentation from docstrings. Docstrings can be written in
|
|
||||||
`Google style`_ (recommended!), `NumPy style`_ and `classical style`_.
|
|
||||||
|
|
||||||
|
|
||||||
Contents
|
Contents
|
||||||
========
|
========
|
||||||
|
|
||||||
|
@ -30,6 +11,8 @@ Contents
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
Overview <readme>
|
Overview <readme>
|
||||||
|
Installing <installing>
|
||||||
|
Running <running>
|
||||||
Contributions & Help <contributing>
|
Contributions & Help <contributing>
|
||||||
License <license>
|
License <license>
|
||||||
Authors <authors>
|
Authors <authors>
|
||||||
|
@ -43,19 +26,3 @@ Indices and tables
|
||||||
* :ref:`genindex`
|
* :ref:`genindex`
|
||||||
* :ref:`modindex`
|
* :ref:`modindex`
|
||||||
* :ref:`search`
|
* :ref:`search`
|
||||||
|
|
||||||
.. _toctree: https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html
|
|
||||||
.. _reStructuredText: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
|
|
||||||
.. _references: https://www.sphinx-doc.org/en/stable/markup/inline.html
|
|
||||||
.. _Python domain syntax: https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#the-python-domain
|
|
||||||
.. _Sphinx: https://www.sphinx-doc.org/
|
|
||||||
.. _Python: https://docs.python.org/
|
|
||||||
.. _Numpy: https://numpy.org/doc/stable
|
|
||||||
.. _SciPy: https://docs.scipy.org/doc/scipy/reference/
|
|
||||||
.. _matplotlib: https://matplotlib.org/contents.html#
|
|
||||||
.. _Pandas: https://pandas.pydata.org/pandas-docs/stable
|
|
||||||
.. _Scikit-Learn: https://scikit-learn.org/stable
|
|
||||||
.. _autodoc: https://www.sphinx-doc.org/en/master/ext/autodoc.html
|
|
||||||
.. _Google style: https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings
|
|
||||||
.. _NumPy style: https://numpydoc.readthedocs.io/en/latest/format.html
|
|
||||||
.. _classical style: https://www.sphinx-doc.org/en/master/domains.html#info-field-lists
|
|
||||||
|
|
|
@ -0,0 +1,5 @@
|
||||||
|
=======
|
||||||
|
Installing
|
||||||
|
=======
|
||||||
|
|
||||||
|
Install using ``pip``? Not really sure yet. :)
|
|
@ -0,0 +1,8 @@
|
||||||
|
=======
|
||||||
|
Running
|
||||||
|
=======
|
||||||
|
|
||||||
|
1. Set up your ``hetrixtools.cfg`` file in ``/usr/local/etc/hetrixtools``
|
||||||
|
2. Add the ``hetrixtools`` to ``/usr/local/etc/rc.d``
|
||||||
|
3. Run ``sysrc hetrixtools_enable=YES`` to add it to ``/etc/rc.conf``
|
||||||
|
|
Loading…
Reference in New Issue