# 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)`
Raw data
{
"_id": null,
"home_page": "https://github.com/i2mint/epythet",
"name": "epythet",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "documentation, publishing",
"author": "Otosense",
"author_email": "andie.phan@analog.com",
"download_url": "https://files.pythonhosted.org/packages/d3/52/1deeceb43c4a6d491160685a93943fe0535c5d2cd839c70ae8f1f7551f08/epythet-0.1.6.tar.gz",
"platform": "any",
"description": "# epythet\n\nDocumentation and packaging tools.\nLess humdrum, more automation, earlier at the pub.\n\n[Full documentation here](https://i2mint.github.io/epythet/index.html) generated by Epythet.\n\n# Getting Started\nFollow the [Sphinx Installation Guide](https://www.sphinx-doc.org/en/master/usage/installation.html)\n\n```\npip install epythet\n```\nFollow the short [Quickstart Guide](https://i2mint.github.io/epythet/module_docs/epythet.html#quickstart)\n\n# About\nTired 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\n [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.\n\n\n# Publishing to GitHub Page with GitHub Actions\nAdd 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.\n```\nname: GitHub Pages\n\non:\n workflow_run:\n workflows: [\"Continuous Integration\"]\n types:\n - completed\n\njobs:\n deploy:\n runs-on: ubuntu-latest\n steps:\n - uses: i2mint/epythet/actions/publish-github-pages@master\n with:\n github-token: ${{ secrets.GITHUB_TOKEN }}\n docs-branch: \"gh-pages\"\n docs-dir: \"./docsrc/_build/html/\"\n python-version: \"3.10\"\n```\nSetup the GitHub Pages for your repo after the target docs-branch is created. Set the target branch (default: \"gh-pages\") and folder as `/(root)`\n\n",
"bugtrack_url": null,
"license": "Apache Software License",
"summary": "Tools for documentation and packaging",
"version": "0.1.6",
"project_urls": {
"Homepage": "https://github.com/i2mint/epythet"
},
"split_keywords": [
"documentation",
" publishing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2b6936e32d3aa371e3915566713e6479a0ef7bddc53fdd5d95988aa06aa1362c",
"md5": "3fba40cc1b2613f1b9d3b18d5c0493ea",
"sha256": "e265664d445d53e6d601304e5ab40bd8525a3b4151cce2ce6655744556387fa6"
},
"downloads": -1,
"filename": "epythet-0.1.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3fba40cc1b2613f1b9d3b18d5c0493ea",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 24790,
"upload_time": "2024-08-13T11:24:44",
"upload_time_iso_8601": "2024-08-13T11:24:44.274900Z",
"url": "https://files.pythonhosted.org/packages/2b/69/36e32d3aa371e3915566713e6479a0ef7bddc53fdd5d95988aa06aa1362c/epythet-0.1.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d3521deeceb43c4a6d491160685a93943fe0535c5d2cd839c70ae8f1f7551f08",
"md5": "e4eeec0aedfa426fd1df79a4de7249c5",
"sha256": "18094753e01b585b16514c71f24e73163b97b4c7954219ebc54eeae1763bfc9b"
},
"downloads": -1,
"filename": "epythet-0.1.6.tar.gz",
"has_sig": false,
"md5_digest": "e4eeec0aedfa426fd1df79a4de7249c5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 20644,
"upload_time": "2024-08-13T11:24:45",
"upload_time_iso_8601": "2024-08-13T11:24:45.887577Z",
"url": "https://files.pythonhosted.org/packages/d3/52/1deeceb43c4a6d491160685a93943fe0535c5d2cd839c70ae8f1f7551f08/epythet-0.1.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-13 11:24:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "i2mint",
"github_project": "epythet",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "epythet"
}
JSON
