https://github.com/i2mint/epythet
Tools for documentation
https://github.com/i2mint/epythet
docstring documentation documentation-generator documentation-tool github-actions github-page python python-3 python3 restructuredtext rst sphinx-doc sphinx-documentation
Last synced: 5 months ago
JSON representation
Tools for documentation
- Host: GitHub
- URL: https://github.com/i2mint/epythet
- Owner: i2mint
- License: apache-2.0
- Created: 2020-08-22T01:15:58.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-08-22T20:12:38.000Z (7 months ago)
- Last Synced: 2025-08-22T22:47:42.806Z (7 months ago)
- Topics: docstring, documentation, documentation-generator, documentation-tool, github-actions, github-page, python, python-3, python3, restructuredtext, rst, sphinx-doc, sphinx-documentation
- Language: Python
- Homepage: https://i2mint.github.io/epythet/
- Size: 6.58 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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 Page with GitHub Actions
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"
```
Setup the GitHub Pages for your repo after the target docs-branch is created. Set the target branch (default: "gh-pages") and folder as `/(root)`
