search

ipums / ipumspy

Mozilla Public License 2.0
8 stars 6 forks source link

Docs update #9

Closed renae-r closed 3 years ago

renae-r commented 3 years ago

Added code of conduct and contributing guidelines based on what is currently included for ipumsr. Eventually I would like to move some of the "getting started" info from the README to github pages as well as add a change log, but that can't happen until the repo is public. Open to alternatives to github pages if others have strong feelings.

khwilson commented 3 years ago

Typically, python documentation is built using sphinx in the classic "Read the Docs" format. For instance, here is pandera and this pushes to readthedocs. You can certainly host it on github pages instead!

khwilson commented 3 years ago

Here's a shell of a commit for making documentation using Sphinx https://github.com/ipums/ipumspy/pull/10 . You can build locally thus:

poetry install
cd docs
make html
cd _build/html
python3 -m http.server

and then in your browser you can navigate to http://localhost:8000 and see the contents of the documentation. As for where to put it, once everything goes public, we can add the doc build and push to the github workflow :-)

renae-r commented 3 years ago

ah cool! Thanks @khwilson! I am not attached to github pages - it is just what I know. I'll merge in both of these PRs.