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

Updating the Autodocs #1470

Merged
merged 61 commits into from
Aug 28, 2024
Merged

Updating the Autodocs #1470

merged 61 commits into from
Aug 28, 2024

Conversation

DominicWC
Copy link
Collaborator

@DominicWC DominicWC commented Jul 3, 2024

  • Tests for new functionality/models or Tests to reproduce the bug-fix in code.
  • Updated documentation of features that add new functionality.
  • Update CHANGELOG.md with major/minor changes.

This pull request fixes several small documentation issues and expands the autodocs for the HARK models to make them more informative. So far ConsIndShockModel, ConsIndShockModelFast, and ConsPrefShockModel have been updated. I'm currently working on the others. It also substantially reworks the installation guide.

@DominicWC
Copy link
Collaborator Author

DominicWC commented Jul 9, 2024

I made a small change to core.py, could someone who understands how core.py works check that it won't cause problems?
It fails one of the automatic tests, but it hasn't caused any problems in my local installation.

commit c84b30e
Author: dominicWC <135868541+DominicWC@users.noreply.github.com>
Date:   Tue Jul 16 18:34:43 2024 -0400

    Updating guidance on adding notebooks to match new system

commit d2ae2d5
Author: dominicWC <135868541+DominicWC@users.noreply.github.com>
Date:   Tue Jul 16 18:17:33 2024 -0400

    grr

commit 672e6c1
Author: dominicWC <135868541+DominicWC@users.noreply.github.com>
Date:   Tue Jul 16 18:08:38 2024 -0400

    links grr

commit 7e9c695
Author: dominicWC <135868541+DominicWC@users.noreply.github.com>
Date:   Tue Jul 16 18:01:29 2024 -0400

    Adjustments for linux relative links

commit f8c0a8d
Author: dominicWC <135868541+DominicWC@users.noreply.github.com>
Date:   Tue Jul 16 17:57:23 2024 -0400

    This took way to long, no more symlinks

commit e3cf5dc
Author: dominicWC <135868541+DominicWC@users.noreply.github.com>
Date:   Mon Jul 15 14:07:17 2024 -0400

    Links

commit 3f5835a
Author: dominicWC <135868541+DominicWC@users.noreply.github.com>
Date:   Mon Jul 15 14:01:20 2024 -0400

    Big fix

commit 0de1e32
Author: dominicWC <135868541+DominicWC@users.noreply.github.com>
Date:   Mon Jul 15 12:27:49 2024 -0400

    Revert "test"

    This reverts commit 25ae5ae.

commit 70ee999
Author: dominicWC <135868541+DominicWC@users.noreply.github.com>
Date:   Mon Jul 15 12:27:43 2024 -0400

    Revert "non functional notebook?"

    This reverts commit f2cde4a.

commit f2cde4a
Author: dominicWC <135868541+DominicWC@users.noreply.github.com>
Date:   Mon Jul 15 12:18:51 2024 -0400

    non functional notebook?

commit 25ae5ae
Author: dominicWC <135868541+DominicWC@users.noreply.github.com>
Date:   Mon Jul 15 12:15:18 2024 -0400

    test

commit c32ea97
Author: dominicWC <135868541+DominicWC@users.noreply.github.com>
Date:   Sun Jul 14 17:05:52 2024 -0400

    Adding instructions for adding notebooks to contributing.md

commit 880f5e2
Author: dominicWC <135868541+DominicWC@users.noreply.github.com>
Date:   Fri Jul 12 16:11:25 2024 -0400

    Small fixes, and added notebooks to index.rst

commit bf7d75d
Author: alanlujan91 <alanlujan91@gmail.com>
Date:   Thu Jul 11 11:41:00 2024 -0400

    create symlinks

commit ac797ae
Author: alanlujan91 <alanlujan91@gmail.com>
Date:   Thu Jul 11 11:35:41 2024 -0400

    run notebooks

commit d132c3d
Author: alanlujan91 <alanlujan91@gmail.com>
Date:   Thu Jul 11 10:57:20 2024 -0400

    put back images?

commit 31baea5
Author: alanlujan91 <alanlujan91@gmail.com>
Date:   Thu Jul 11 10:43:00 2024 -0400

    clean up notebooks

commit 1b68bf6
Author: alanlujan91 <alanlujan91@gmail.com>
Date:   Thu Jul 11 10:37:41 2024 -0400

    delete unnecessary files

commit 3871b27
Author: alanlujan91 <alanlujan91@gmail.com>
Date:   Thu Jul 11 10:28:14 2024 -0400

    move examples
…e old links (todo: edit the econark webpage)
@sbenthall
Copy link
Contributor

image

@sbenthall
Copy link
Contributor

image

@sbenthall
Copy link
Contributor

image

@mnwhite mnwhite merged commit 1a34e73 into econ-ark:master Aug 28, 2024
15 checks passed
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.

3 participants