Skip to content

Commit

Permalink
Mention docs in README, add badge for docs, add missing basic_usage.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
mschmidt87 committed Jul 18, 2020
1 parent 2d58660 commit dad64d7
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@
:target: https://github.com/psf/black
.. image:: https://coveralls.io/repos/github/Happy-Algorithms-League/python-gp/badge.svg?branch=master
:target: https://coveralls.io/github/Happy-Algorithms-League/python-gp?branch=master
.. image:: https://readthedocs.org/projects/ansicolortags/badge/?version=latest
:target: https://happy-algorithms-league.github.io/hal-cgp/

Cartesian genetic programming (CGP) in pure Python.

Expand All @@ -36,8 +38,6 @@ Figure from Jordan, Schmidt, Senn & Petrovici, "Evolving to learn: discovering i

.. long-description-end
A simple example of CGP applied to a symbolic regression problem can be found in `examples/example_evo_regression.py`.

.. installation-start
============
Installation
Expand Down Expand Up @@ -72,11 +72,14 @@ The adventurous can install the most recent development version directly from ou
.. installation-end
.. basic-usage-start
===========
Basic usage
===========

For detailed documentation, please refer to [https://happy-algorithms-league.github.io/hal-cgp/](https://happy-algorithms-league.github.io/hal-cgp/). Here we only provide a preview.

.. basic-usage-start
Follow these steps to solve a basic regression problem:

1. Define an objective function.
Expand Down
7 changes: 7 additions & 0 deletions docs/basic_usage.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
===========
Basic usage
===========

.. include:: ../README.rst
:start-after: basic-usage-start
:end-before: basic-usage-end

0 comments on commit dad64d7

Please sign in to comment.