-
Notifications
You must be signed in to change notification settings - Fork 71
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
Improved documentation website #179
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
now install pastas
Don't know how to get this to work for no.
Looks good! I think this will help people a lot. Two remarks:
|
dbrakenhoff
reviewed
Mar 18, 2020
dbrakenhoff
reviewed
Mar 18, 2020
dbrakenhoff
reviewed
Mar 18, 2020
dbrakenhoff
reviewed
Mar 18, 2020
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.
See comments in code
Final commit before merging into the dev-branch
No idea why that happens. Let's hope people don't check on their phone to often..
I removed empty items but mostly filled them. |
dbrakenhoff
approved these changes
Mar 18, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
development
Indicates development of new features
enhancement
Indicates improvement of existing features
help wanted
Indicates that a maintainer wants help on an issue or pull request
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR bring a totally new documentation website to Pastas, using a new theme. On the new website is a lot more clear where to find things due to better navigation options for the theme. The API docs have been strongly improved, summarising different modules and classes and providing a better overview of all the methods and classes available in Pastas (see e.g., https://pastas.readthedocs.io/en/improve_docs/api/statistics.html). These are now focused on Users instead of developers.
Basically no information was removed, and only information was added. There are still some sections to fill (help welcome) but most of the work is done. Most importantly, the new website allows us to better structure information and make more information available over time.