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

Reorganisation of examples #138

Merged
merged 26 commits into from
Aug 3, 2023
Merged

Reorganisation of examples #138

merged 26 commits into from
Aug 3, 2023

Conversation

albertpod
Copy link
Member

This PR addresses #97

@albertpod albertpod requested a review from bvdmitri July 6, 2023 10:48
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@albertpod albertpod requested a review from bartvanerp July 6, 2023 10:48
@codecov
Copy link

codecov bot commented Jul 6, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (92d325a) 81.22% compared to head (2573579) 81.22%.

❗ Current head 2573579 differs from pull request most recent head a275810. Consider uploading reports for the commit a275810 to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #138   +/-   ##
=======================================
  Coverage   81.22%   81.22%           
=======================================
  Files          11       11           
  Lines        1209     1209           
=======================================
  Hits          982      982           
  Misses        227      227           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@bartvanerp
Copy link
Member

Now also fixes #136.

@albertpod
Copy link
Member Author

ping @bvdmitri

The reorganization is completed.

@albertpod
Copy link
Member Author

kind ping @bvdmitri

@bvdmitri
Copy link
Member

bvdmitri commented Aug 1, 2023

ping @albertpod @bartvanerp

I fixed the script that generates the examples and the documentation. The layout of the .meta.jl has been changed. Could you please add descriptions for each sub-category (except hidden_examples) and verify/improve descriptions of each example? For example the description of the Autoregressive Models example is outdated.

  • make examples - to generate the examples, reads data from the .meta.jl
  • make docs - to generate the documentation AFTER the examples have been pre-generated
  • open docs/build/index.html preview the documentation (linux only, on windows just open the file manually)

@albertpod albertpod marked this pull request as ready for review August 3, 2023 11:30
@bvdmitri bvdmitri merged commit 7c8cd0c into main Aug 3, 2023
6 of 11 checks passed
@bvdmitri bvdmitri deleted the dev-examples branch August 3, 2023 12:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Some equations in the Assesing Peoples Skills demo are broken Restructure examples in documentation
3 participants