diff --git a/.DS_Store b/.DS_Store deleted file mode 100644 index df69b2e..0000000 Binary files a/.DS_Store and /dev/null differ 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="""