-
Notifications
You must be signed in to change notification settings - Fork 36
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs update #28
Docs update #28
Conversation
Remove coesa header Add new rst files to doc Add badges Include mail badge Add email badge Correct badge Changed logo to _static Remove script examples Logo and python block codes New docs structure Add vertical spacer rst files Delete new folders Apply black Added about sectoin Test documentation All documentation is completed
Update readme code-blocks
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You're my hero 😍 It's so satisfying to see this necessary update to scikit-aero after so many years! I just left some comments about current packaging practices.
And, by the way THE LOGO IS AWESOME
README.rst
Outdated
@@ -87,9 +116,11 @@ version of IPython and its dependencies. | |||
Install | |||
======= | |||
|
|||
This package uses distutils. To install, execute as usual:: | |||
This package uses distutils. To install, execute as usual: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I recommend removing the references to distutils and just state that it can be installed using pip install scikit-aero
, and pip install --editable .
for local installs 😊
The reason is that python setup.py xxx
is supposed to go away... Soon! The PyPA is standardizing around stuff that makes setup.py
files disappear.
README.rst
Outdated
|
||
.. code-block:: bash | ||
|
||
$ py.test |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nowadays it's just pytest
Remove distutils intallation tutorial
This tries to solve #3. With this pull request new features are implemented such us:
sphinx_rtd_theme
.