Skip to content
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 16 commits into from
Mar 18, 2020
Merged

Improved documentation website #179

merged 16 commits into from
Mar 18, 2020

Conversation

raoulcollenteur
Copy link
Member

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.

@raoulcollenteur raoulcollenteur added enhancement Indicates improvement of existing features help wanted Indicates that a maintainer wants help on an issue or pull request development Indicates development of new features labels Mar 17, 2020
@raoulcollenteur raoulcollenteur added this to the 0.14.0 milestone Mar 17, 2020
@rubencalje
Copy link
Collaborator

Looks good! I think this will help people a lot. Two remarks:

  • On my phone the menu button does not do anything. Do you know why this is the case?
  • Some items are empty, like the about section. Maybe we could remove those for now?

doc/about/faqs.rst Outdated Show resolved Hide resolved
pastas/stressmodels.py Outdated Show resolved Hide resolved
Copy link
Member

@dbrakenhoff dbrakenhoff left a 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
@raoulcollenteur
Copy link
Member Author

  • On my phone the menu button does not do anything. Do you know why this is the case?

No idea why that happens. Let's hope people don't check on their phone to often..

  • Some items are empty, like the about section. Maybe we could remove those for now?

I removed empty items but mostly filled them.

@raoulcollenteur raoulcollenteur requested review from rubencalje and removed request for rubencalje March 18, 2020 20:06
@raoulcollenteur raoulcollenteur self-assigned this Mar 18, 2020
@raoulcollenteur raoulcollenteur merged commit 61d5e13 into dev Mar 18, 2020
@raoulcollenteur raoulcollenteur deleted the improve_docs branch March 18, 2020 21:51
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants