| Name | sphinx-lesson JSON |
| Version |
0.8.16
JSON |
| download |
| home_page | |
| Summary | Sphinx extension for CodeRefinery lessons |
| upload_time | 2024-03-08 00:37:32 |
| maintainer | |
| docs_url | None |
| author | Richard Darst |
| requires_python | >=3.3 |
| license | |
| keywords |
sphinx-extension
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Sphinx test lesson
==================
This is a Sphinx extension for software-carpentry style
lessons. It is designed as a replacement for the Jekyll-based software
templates.
* `View the documentation (and example) on github pages
<https://coderefinery.github.io/sphinx-lesson/>`__.
* `Template repository, to copy from
<https://github.com/coderefinery/sphinx-lesson-template/>`__.
Features
--------
- Sphinx, including power from all of its extensions.
- ReST
- Markdown via the `myst_parser` parser, so has access to all Sphinx
directives natively
- Jupyter as a source format, including executing the notebook (via
``myst_nb``).
- Automatically building via Github Actions and automatic deployment
to Github Pages. Included workflow file builds all branches, so you
can also preview pull requests.
- Directives for exercises/prereq/etc, works in both ReST and md.
- The Sphinx part can be separated into a separately installable
and versionable Python package, so we don't need git sub-modules.
- Execute code cells in markdown (via ``myst_nb``).
- Consists of sub-extensions for substitutions. Adding
``sphinx_lesson`` as an extension will bring in these:
- ``sphinx_lesson.directives`` (the core directives)
- ``sphinx_lesson.md_transforms`` (reprocess some other markdown
format into myst_nb format)
- ``myst_nb`` (not developed by us)
Host Site Locally for Development
---------------------------------
1. Create a virtual python environment::
python -m venv venv
2. Activate the virtual environment::
source activate venv/bin/activate
3. Install python packages::
pip install -r requirements.txt
4. Build local files (this can also be used for deployment)::
make html
# Output in _build/html/
make clean html # clean + full rebuild
5. Or, start a live-compiled service for your compiled site for local development::
make livehtml
Then view created site in your browser at `http://localhost:8000 <http://localhost:8000>`__ (follow the link in your console).
Status
------
In beta use by CodeRefinery and active development. External users
would be fine (but let us know so we know to keep things stable).
Raw data
{
"_id": null,
"home_page": "",
"name": "sphinx-lesson",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.3",
"maintainer_email": "",
"keywords": "sphinx-extension",
"author": "Richard Darst",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/81/97/dbacedb91a28f667b899c6b363ec3698c8d004beb758f3125100c719d8d7/sphinx_lesson-0.8.16.tar.gz",
"platform": null,
"description": "Sphinx test lesson\n==================\n\nThis is a Sphinx extension for software-carpentry style\nlessons. It is designed as a replacement for the Jekyll-based software\ntemplates.\n\n* `View the documentation (and example) on github pages\n <https://coderefinery.github.io/sphinx-lesson/>`__.\n* `Template repository, to copy from\n <https://github.com/coderefinery/sphinx-lesson-template/>`__.\n\n\nFeatures\n--------\n\n- Sphinx, including power from all of its extensions.\n- ReST\n- Markdown via the `myst_parser` parser, so has access to all Sphinx\n directives natively\n- Jupyter as a source format, including executing the notebook (via\n ``myst_nb``).\n- Automatically building via Github Actions and automatic deployment\n to Github Pages. Included workflow file builds all branches, so you\n can also preview pull requests.\n- Directives for exercises/prereq/etc, works in both ReST and md.\n- The Sphinx part can be separated into a separately installable\n and versionable Python package, so we don't need git sub-modules.\n- Execute code cells in markdown (via ``myst_nb``).\n- Consists of sub-extensions for substitutions. Adding\n ``sphinx_lesson`` as an extension will bring in these:\n\n - ``sphinx_lesson.directives`` (the core directives)\n - ``sphinx_lesson.md_transforms`` (reprocess some other markdown\n format into myst_nb format)\n - ``myst_nb`` (not developed by us)\n\n\n\nHost Site Locally for Development\n---------------------------------\n\n1. Create a virtual python environment::\n\n python -m venv venv\n\n2. Activate the virtual environment::\n\n source activate venv/bin/activate\n\n3. Install python packages::\n\n pip install -r requirements.txt\n\n4. Build local files (this can also be used for deployment)::\n\n make html\n # Output in _build/html/\n make clean html # clean + full rebuild\n\n5. Or, start a live-compiled service for your compiled site for local development::\n\n make livehtml\n\n Then view created site in your browser at `http://localhost:8000 <http://localhost:8000>`__ (follow the link in your console).\n\n\n\nStatus\n------\n\nIn beta use by CodeRefinery and active development. External users\nwould be fine (but let us know so we know to keep things stable).\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Sphinx extension for CodeRefinery lessons",
"version": "0.8.16",
"project_urls": null,
"split_keywords": [
"sphinx-extension"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a0e83c809aa1c82a5f7a2783ed1e871c0c98400c23de25539e4082e6c111cf82",
"md5": "f4237a7161e0632e8e3ad1f247af7730",
"sha256": "3bedb57deb1d772f189ed537f236f5d1544b6d521e61949df090e8d90c1c0ef3"
},
"downloads": -1,
"filename": "sphinx_lesson-0.8.16-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f4237a7161e0632e8e3ad1f247af7730",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.3",
"size": 11480,
"upload_time": "2024-03-08T00:37:30",
"upload_time_iso_8601": "2024-03-08T00:37:30.358664Z",
"url": "https://files.pythonhosted.org/packages/a0/e8/3c809aa1c82a5f7a2783ed1e871c0c98400c23de25539e4082e6c111cf82/sphinx_lesson-0.8.16-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8197dbacedb91a28f667b899c6b363ec3698c8d004beb758f3125100c719d8d7",
"md5": "260a682e732611d76535fec34ca5f77f",
"sha256": "38947d1e319c832f9ecb110f377a6df15bee1809290c40a112243de41b5dfcfc"
},
"downloads": -1,
"filename": "sphinx_lesson-0.8.16.tar.gz",
"has_sig": false,
"md5_digest": "260a682e732611d76535fec34ca5f77f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.3",
"size": 36473,
"upload_time": "2024-03-08T00:37:32",
"upload_time_iso_8601": "2024-03-08T00:37:32.005802Z",
"url": "https://files.pythonhosted.org/packages/81/97/dbacedb91a28f667b899c6b363ec3698c8d004beb758f3125100c719d8d7/sphinx_lesson-0.8.16.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-08 00:37:32",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "sphinx-lesson"
}
