Skip to content

Commit

Permalink
Move use section from README to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mdpiper committed Apr 11, 2024
1 parent 436ca1c commit b2753ea
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 21 deletions.
21 changes: 0 additions & 21 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,27 +63,6 @@ For more detailed information,
including how to install the *babelizer* from source,
see the `installation instructions`_ in the documentation.

Use
---

Generate a Python package for a library that implements a BMI,
sending output to the current directory

.. code:: bash
babelize init babel.toml
Update an existing repository

.. code:: bash
babelize update
For complete examples of using the *babelizer*
to wrap C and Fortran libraries exposing a BMI,
see the User Guide of the `documentation`_.


.. Links:
.. _Basic Model Interface: https://bmi.readthedocs.io/
Expand Down
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ User Guide
install
cli
configuration
use
example-c
example-fortran
glossary
Expand Down
20 changes: 20 additions & 0 deletions docs/source/use.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Using the *babelizer*
=====================

Given a completed *babelizer* :ref:`configuration file <configuration-file>`,
generate a Python package for a library that implements a BMI,
sending output to the current directory.

.. code:: bash
babelize init babel.toml
Update an existing repository.

.. code:: bash
babelize update
For in-depth examples of using the *babelizer*
to wrap libraries exposing a BMI,
see :ref:`example-c` and :ref:`example-fortran`.

0 comments on commit b2753ea

Please sign in to comment.