Skip to content

Commit

Permalink
Add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
MaxGhenis committed Oct 4, 2020
1 parent b699da9 commit 61252d8
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 0 deletions.
22 changes: 22 additions & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Book settings
title: scf documentation
author: Max Ghenis

launch_buttons:
colab_url: "https://colab.research.google.com"

repository:
url: https://github.com/MaxGhenis/scf
branch: master
path_to_book: docs

html:
use_edit_page_button : true
use_repository_button : true
use_issues_button : true

sphinx:
extra_extensions : ['sphinx.ext.autodoc', 'sphinx.ext.mathjax',
'sphinx.ext.viewcode', 'sphinx.ext.napoleon',
'alabaster'] # A list of extra extensions to load by Sphinx.
config : # key-value pairs to directly over-ride the Sphinx configuration
1 change: 1 addition & 0 deletions docs/_toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- file: home
19 changes: 19 additions & 0 deletions docs/home.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# `scf` documentation

`scf` is a Python package for working with Survey of Consumer Finances microdata.

Install via:

```
pip install git+https://github.com/MaxGhenis/scf.git
```

Try it with:
```
import scf
scf.load(years=[2016, 2019], cols=['income', 'networth'])
```

This will return a `pandas` `DataFrame` with columns for
`income`, `networth`, `year`, and `wgt` (the survey weight).

0 comments on commit 61252d8

Please sign in to comment.