Metadata-Version: 2.4
Name: epythet
Version: 0.1.13
Summary: Tools for documentation and packaging
Project-URL: Homepage, https://github.com/i2mint/epythet
Author-email: andie.phan@analog.com
License: Apache-2.0
License-File: LICENSE
Keywords: documentation,publishing
Requires-Python: >=3.10
Requires-Dist: argh>=0.26.2
Requires-Dist: commonmark>=0.9.1
Requires-Dist: dol
Requires-Dist: myst-parser>=0.15.2
Requires-Dist: requests
Requires-Dist: sphinx-copybutton>=0.4.0
Requires-Dist: sphinx-rtd-theme>=1.0.0
Requires-Dist: sphinx-toggleprompt>=0.0.5
Requires-Dist: sphinx>=3.3.1
Requires-Dist: tomli
Provides-Extra: dev
Requires-Dist: hubcap; extra == 'dev'
Requires-Dist: pandas; extra == 'dev'
Requires-Dist: pytest-cov>=4.0; extra == 'dev'
Requires-Dist: pytest>=7.0; extra == 'dev'
Requires-Dist: ruff>=0.1.0; extra == 'dev'
Provides-Extra: docs
Requires-Dist: sphinx-rtd-theme>=1.0; extra == 'docs'
Requires-Dist: sphinx>=6.0; extra == 'docs'
Description-Content-Type: text/markdown

# epythet

Documentation and packaging tools.
Less humdrum, more automation, earlier at the pub.

[Full documentation here](https://i2mint.github.io/epythet/index.html) generated by Epythet.

# Getting Started
Follow the [Sphinx Installation Guide](https://www.sphinx-doc.org/en/master/usage/installation.html)

```
pip install epythet
```
Follow the short [Quickstart Guide](https://i2mint.github.io/epythet/module_docs/epythet.html#quickstart)

# About
Tired of learning new frameworks and just need something to quickly display your docstrings in your python files? You've come to the right place. Epythet is built on
 [Sphinx Python Documentation Generator](https://www.sphinx-doc.org/en/master/index.html) but automatically generates pages for each module .py files and a table of contents.


# Publishing to GitHub Pages with GitHub Actions

## Step 1: Add the CI workflow

Add workflow [.github/workflows/publish-docs.yml](https://github.com/i2mint/epythet/blob/master/.github/workflows/publish-docs.yml) to your repo and modify the trigger conditions to suit your needs.  Example below will run automatically when the other "Continuous Integration" workflow is completed.
```
name: GitHub Pages

on:
  workflow_run:
    workflows: ["Continuous Integration"]
    types:
      - completed

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: i2mint/epythet/actions/publish-github-pages@master
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          docs-branch: "gh-pages"
          docs-dir: "./docsrc/_build/html/"
          python-version: "3.10"
```

## Step 2: Enable GitHub Pages

After the CI runs and creates the `gh-pages` branch, you need to tell GitHub to
actually serve it. There are two ways to do this:

### The clicky way (for those who enjoy navigating settings menus)

Go to your repo's **Settings > Pages**, set the source branch to `gh-pages` and
the folder to `/ (root)`, then click Save.

![image](https://user-images.githubusercontent.com/22692594/212193474-80b287e2-211c-470d-aa7c-9f779bdd3866.png)

### The fast way (for those who value their time)

If you have the [`gh` CLI](https://cli.github.com/) installed:

```bash
# Check if Pages is set up correctly
epythet check-pages owner/repo

# Enable or fix Pages configuration
epythet configure-pages owner/repo
```

Or from Python:

```python
from epythet import check_pages_setup, enable_pages

# Diagnose
check_pages_setup('owner/repo')

# Fix
enable_pages('owner/repo')
```

You can also point these at a local git checkout instead of `owner/repo`:

```bash
epythet check-pages .
epythet configure-pages /path/to/my/project
```

These tools work with either the `gh` CLI (recommended) or a `GITHUB_TOKEN`
environment variable.

See [CI epythet troubleshooting](https://github.com/i2mint/epythet/wiki/CI-epythet-troubleshooting).

