From f92bcee66424d09c26536d3e943e04d81bd7c859 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Sergio=20S=C3=A1nchez=20Zavala?= <ssanchez@alluma.org>
Date: Fri, 18 Feb 2022 12:39:40 -0800
Subject: [PATCH] Update docs (#271)

* virtual envs

* remove poetry and automation files

* add license

* update README based off simonw/python-lib's

* add setup.py

* remove unnecessary files

* move to utils module

* Move to simple test and publish actions

* DS_Store

* typed file

* add tqdm dependency

* add httpx and pandas

* extract funcs

* move to using utils module

* move to httpx and black code

* move to utils module

* refactor ACS class

* initial restructure, working

* drop docker for now

* drop docker for now

* update CONTRIBUTING

* clean PR template

* dropping unnecessary files

* pandas 1.1 for py36

* add mkdocs

* minimal mkdocs

* don't test on 3.10 yet

* doesn't have to be google format

* set up mkdocs

* minimal working docs

* clean docs folder

* add basic requirements

* add typer for cli

* Add CLI with 2 basic commands

* add version flag

* add test for cli

* black

* test instantiated ACS

* rename _download

* check local before downloading

* update docs to include CLI usage

* switch to Options

* Add basic docstring

* change method name to just .download()

* mvp docs

* dropped tqdm

* minor change

* Drop mypy config

* release candidate for version 0.1

* create app_dir

* black

* extract folder is in lowercase

* create app_dir at installation

* sort imports and black code

* doesnt work

* Update utils.py

* DS STORE

* update actions

* exists = true

* clean up docs and use mkdocs-typer
---
 .DS_Store                             | Bin 6148 -> 0 bytes
 .github/workflows/greetings.yml       |   2 +-
 .github/workflows/release-drafter.yml |   2 +-
 docs/reference/cli.md                 |   6 ++++++
 docs/reference/surveys.md             |   8 ++++++++
 mkdocs.yml                            |  28 +++++++++++++++++++++-----
 pypums/utils.py                       |   2 +-
 setup.py                              |   2 +-
 8 files changed, 41 insertions(+), 9 deletions(-)
 delete mode 100644 .DS_Store
 create mode 100644 docs/reference/cli.md
 create mode 100644 docs/reference/surveys.md

diff --git a/.DS_Store b/.DS_Store
deleted file mode 100644
index df69b2ea9ac0345af7fba286a9647d5b2b46b8c8..0000000000000000000000000000000000000000
GIT binary patch
literal 0
HcmV?d00001

literal 6148
zcmeHK%}N6?5Kh{v*^1bMV2^w8)<cW^ISEUx2XDfP9#q<0x7dZck?z(-Yh_<U-^eHM
zb(~4kVyS{B5jz8uZ!(!l$hS)-VT|$iIH)mJVvGq;#GD1q7lPxcOOi7lM2>U#X?*7o
zr4RkLrD$^eMF#NO6<EL|yJqp{@8{nQ!#Jr{-+3-ySX<u^q9}@6#VdCpQ#bLFaoqMs
z7uY-Tl7VmRQz?gY+w;%De%dYV9Lgy1!l*w|$zjlkkjwKh3S`=r<0y#LJgy!P!V*@u
zRGv)gjYh?;H|x`iJ!!S7VDC4lQ%mgb)eeq(w-1k#r|I*HW|hMasASvV3|_&QZ}8q7
zMMD|gfNvH*iz6fkhyh|?g%~hLpx9iYJ=0c+0b<~14B+`-gCaTxGmYx#fCjIRI9@<R
z0UO^Eh_*q;V5Sj9K)6l?)T!J&F}O|#zir|igPBI1&bV3`<}oXC^FrZjb@1CNoN-4Z
zwZs51u*g7OcS~6RkG_BZFD6ls7$64z6$8A`aXW3;lBumro5NabgZ4mCFfP+LPXR-f
gVu;03Tn1GFej5!y$6%%rJRo!tP&80O4E!nsAGFF)tpET3

diff --git a/.github/workflows/greetings.yml b/.github/workflows/greetings.yml
index a1f6e89..5318ea3 100644
--- a/.github/workflows/greetings.yml
+++ b/.github/workflows/greetings.yml
@@ -6,7 +6,7 @@ jobs:
   greeting:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/first-interaction@v1
+    - uses: actions/first-interaction@v1.1.0
       with:
         repo-token: ${{ secrets.GITHUB_TOKEN }}
         pr-message:  'Hello @${{ github.actor }}, thank you for submitting a PR! We will respond as soon as possible.'
diff --git a/.github/workflows/release-drafter.yml b/.github/workflows/release-drafter.yml
index 5d50046..83a4a43 100644
--- a/.github/workflows/release-drafter.yml
+++ b/.github/workflows/release-drafter.yml
@@ -11,6 +11,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       # Drafts your next Release notes as Pull Requests are merged into "master"
-      - uses: release-drafter/release-drafter@v5.12.1
+      - uses: release-drafter/release-drafter@v5.18.1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/docs/reference/cli.md b/docs/reference/cli.md
new file mode 100644
index 0000000..75b9379
--- /dev/null
+++ b/docs/reference/cli.md
@@ -0,0 +1,6 @@
+# CLI
+
+::: mkdocs-typer
+    :module: pypums.cli
+    :command: cli
+    :prog_name: pypums-cli
diff --git a/docs/reference/surveys.md b/docs/reference/surveys.md
new file mode 100644
index 0000000..73b2270
--- /dev/null
+++ b/docs/reference/surveys.md
@@ -0,0 +1,8 @@
+# Surveys (ACS)
+
+::: pypums.ACS
+    selection:
+        members:
+            - download
+            - as_dataframe
+
diff --git a/mkdocs.yml b/mkdocs.yml
index 646ae00..b74033e 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -1,7 +1,29 @@
 site_name: PyPUMS
 theme: readthedocs
+
+nav:
+  - PyPUMS: index.md
+  - User guide:
+    - Installation: user-guide/installation.md
+    - Usage: user-guide/usage.md
+  - API reference: 
+    - Surveys (ACS): reference/surveys.md
+    - CLI: reference/cli.md
+  - About:
+    - Authors: about/authors.md
+    - Contributing: about/contributing.md
+    - Changelog: about/history.md
+
 plugins:
   - search
+  - autorefs
+  - mkdocstrings:
+      default_handler: python
+      handlers:
+        python:
+          rendering:
+            show_source: false
+            show_root_heading: true
   
 markdown_extensions:
     - smarty
@@ -10,7 +32,6 @@ markdown_extensions:
     - sane_lists
     - admonition
     - codehilite
-    - mkautodoc
     - pymdownx.superfences:
         custom_fences:
         - name: mermaid
@@ -19,7 +40,4 @@ markdown_extensions:
     - pymdownx.tabbed:
         alternate_style: true
     - mdx_include
-
-
-extra_css:
-  - css/custom.css
\ No newline at end of file
+    - mkdocs-typer
diff --git a/pypums/utils.py b/pypums/utils.py
index 311c440..f34fbd2 100644
--- a/pypums/utils.py
+++ b/pypums/utils.py
@@ -14,7 +14,7 @@
 
 app_dir = Path(get_app_dir(__app_name__))
 data_dir = app_dir.joinpath("data")
-data_dir.mkdir(parents = True)
+data_dir.mkdir(parents = True, exist_ok=True)
 
 SURVEYS_BASE_URL = "https://www2.census.gov/programs-surveys/"
 
diff --git a/setup.py b/setup.py
index d6670a2..619fe3c 100644
--- a/setup.py
+++ b/setup.py
@@ -37,7 +37,7 @@ def get_long_description():
     ],
     extras_require={
         "test": ["pytest"],
-        "docs": ["mkdocs", "mdx_include", "mkautodoc", "pymdown-extensions"],
+        "docs": ["mkdocs", "mdx_include", "mkdocstrings", "mkdocs-typer", "pymdown-extensions"],
     },
     python_requires=">=3.6",
     entry_points="""