search

PSLmodels / taxdata

The TaxData project prepares microdata for use with the Tax-Calculator microsimulation project.
http://pslmodels.github.io/taxdata/
Other
21 stars 30 forks source link

Documentation updates #401

Closed jdebacker closed 3 years ago

jdebacker commented 3 years ago

This PR updates the taxdata documentation. It organizes existing documents into a Jupyter Book format, creates actions to test and deploy these docs, and adds markdown files with the content of three methodological references (which can now be more easily updated to conform with the current methods).

jdebacker commented 3 years ago

FYI, in addition to the documentation updates, I change the environment to allow Python > 3.7 (taxdata runs fine on 3.8 for me) and I changes the GH Action that runs the unit tests to run on Python 3.7 (since using 3.6 for tests gave package conflicts when trying to create the environment).

jdebacker commented 3 years ago

This PR is ready for review.

jdebacker commented 3 years ago

@andersonfrailey if you create a gh-pages branch and commit an empty file to it with the name .nojekyll, I think the docs should deploy to pslmodels.github.io/taxdata.

jdebacker commented 3 years ago

@andersonfrailey pinging - let me know how this looks.

andersonfrailey commented 3 years ago

This is fantastic, @jdebacker, thanks! I can't really tell from reading the Jupyterbook docs, should I create the gh-pages branch before or after this PR is merged?

jdebacker commented 3 years ago

@andersonfrailey Why don't you create it first and commit the .nojekyll file to it. Then merge this PR. Thanks!

andersonfrailey commented 3 years ago

I've created the new branch with the .nojekyll file. Merging this!