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

DOC: improve docs before v1 #386

Merged
merged 5 commits into from
Jul 3, 2023
Merged

Conversation

Gui-FernandesBR
Copy link
Member

@Gui-FernandesBR Gui-FernandesBR commented Jun 27, 2023

We need to update our documentation page before the pre-release.
This will run really fast tho, just some quick TO-DOs below.

Remaining tasks:

For Future PRs:

  • Add plots and prints submodules to docs
  • Generate the MATLAB docs directly from MATLAB

- This was made to improve docs pages
- The main change was related to the different toctree
@Gui-FernandesBR Gui-FernandesBR added the Docs Docs and examples related label Jun 27, 2023
@Gui-FernandesBR Gui-FernandesBR added this to the Release v1.0.0 milestone Jun 27, 2023
@Gui-FernandesBR Gui-FernandesBR self-assigned this Jun 27, 2023
@Gui-FernandesBR Gui-FernandesBR changed the base branch from enh/liquid-motors to beta/v1.0.0 July 1, 2023 02:40
@Gui-FernandesBR
Copy link
Member Author

Reference: https://peps.python.org/pep-0440/

@Gui-FernandesBR
Copy link
Member Author

1st July - 18:56 : Right now I'm getting 560 warnings when building the documentation
1st July - 19:53 : still 114 warnings, but the docs pages look amazing already.

@Gui-FernandesBR Gui-FernandesBR marked this pull request as ready for review July 1, 2023 17:57
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@Gui-FernandesBR
Copy link
Member Author

@phmbressan can you review this one please?

Remember the steps to create the docs pages:

cd docs
pip install -r requirements.txt
make html

pandoc is also a requirement.

@giovaniceotto giovaniceotto merged commit 6f48b07 into beta/v1.0.0 Jul 3, 2023
@Gui-FernandesBR Gui-FernandesBR deleted the doc/improve-docs-before-v1 branch July 4, 2023 08:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Docs and examples related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants