Skip to content

Commit

Permalink
implement flexible get started (#75)
Browse files Browse the repository at this point in the history
  • Loading branch information
jason-bentley authored Nov 25, 2020
1 parent e632d08 commit 60cca8c
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 9 deletions.
10 changes: 8 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. image:: _static/sklearndf_logo.png
.. image:: sphinx/source/_static/sklearndf_logo.png

|
Expand All @@ -17,10 +17,13 @@ To this end, *sklearndf* enhances scikit-learn's estimators as follows:
- **Easy use**:
Simply append DF at the end of your usual scikit-learn class names to get enhanced data frame support!

.. Begin-Badges
|pypi| |conda| |azure_build| |azure_code_cov|
|python_versions| |code_style| |made_with_sphinx_doc| |License_badge|

.. End-Badges
Installation
---------------------

Expand Down Expand Up @@ -241,6 +244,7 @@ BCG GAMMA team. If you would like to know more you can find out about BCG GAMMA
or have a look at
`career opportunities <https://www.bcg.com/en-gb/beyond-consulting/bcg-gamma/careers>`_.

.. Begin-Badges
.. |conda| image:: https://anaconda.org/bcg_gamma/sklearndf/badges/version.svg
:target: https://anaconda.org/BCG_Gamma/sklearndf
Expand All @@ -264,4 +268,6 @@ or have a look at
:target: https://www.sphinx-doc.org/

.. |license_badge| image:: https://img.shields.io/badge/License-Apache%202.0-olivegreen.svg
:target: https://opensource.org/licenses/Apache-2.0
:target: https://opensource.org/licenses/Apache-2.0

.. End-Badges
Binary file removed _static/sklearndf_logo.png
Binary file not shown.
1 change: 1 addition & 0 deletions sphinx/source/.gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
/apidoc/
/getting_started/
6 changes: 0 additions & 6 deletions sphinx/source/getting_started.rst

This file was deleted.

2 changes: 1 addition & 1 deletion sphinx/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Table of contents
:maxdepth: 1
:titlesonly:

Getting started <getting_started>
Getting started <getting_started/getting_started>
API reference <apidoc/sklearndf>
tutorials
contribution_guide
Expand Down

0 comments on commit 60cca8c

Please # to comment.