mirror of
https://github.com/pyscript/pyscript.git
synced 2026-02-16 07:01:15 -05:00
6898daf0ce
* Initial setup. This does a few things: - Adds some placeholders following the Diátaxis framework (https://diataxis.fr) - Sets up Sphinx with MyST parser for Markdown in addition to rST. - Uses the well-known PyData Sphinx theme. - Moves some already existing Markdown files into the docs directory. - Sets up the initial doc review GitHub action to auto-deploy to GitHub pages. * Activate conda env. * Remove custom action. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Make the dir. * Push directly * Add readthedocs config. * Disable GitHub pages deployment for now. * Add release and latest workflows as well. * Make clear that this is work in progress. * Made docs merge ready, added What is PyScript section with example. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Replace `on:tags:` with `on:create:` The existing trigger is apparently not in the GHA spec * Pretty format YAML * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * add s3 sync and permissions * Leave status message in PR. * Redirect from docs.pyscript.net/ to docs.pyscript.net/latest/ * Delete latest directory before deployment. * Update review and release workflows, too. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Allow access to S3 for review and release doc workflow. * Fix name of workflow. * Bump up Python version. * Because YAML. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Revert move to 3.10. * Fix sitemap. * Remove status settgin from release and latest build. * Comment out cleanup. * Add write permissions for statuses. * More permissions? * Fix artifact name. * Use appropriate concurrency. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * .zip not needed * Align name of workflows with CI workflows. * Add checks permission. * Set a notice instead. * Move to sphinx-design. * Add sphinx-autobuild. * Use frontmatter more. * Add section for mdformat but disable it for now. See https://github.com/executablebooks/mdformat-myst/pull/9 for more details. * Fix fencing. * Actually using html renderer. * Revert moving governance files. * Use full URLs for governance docs. * Added warning. * Fix copyright and author. * Another minor fix. * Use GitHub Action summary instead of notice. * Fix variable name. Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Matt Kramer <mkramer@anaconda.com> Co-authored-by: ximena9201 <ximenandrea.ro@gmail.com>
55 lines
1.1 KiB
Markdown
55 lines
1.1 KiB
Markdown
# PyScript
|
|
|
|
```{warning}
|
|
Please note, this documentation is just a placeholder and **should not be used
|
|
in reference material**. Thank you!
|
|
```
|
|
|
|
Welcome to the PyScript documentation!
|
|
|
|
PyScript provides a way for you to run Python code directly in your browser, giving
|
|
anyone the ability to program without infrastructure barriers. Add an interactive
|
|
Python REPL directly to your website, share an interactive dashboard with a colleague
|
|
as an HTML file, or create a client-side Python-powered web application. This documentation
|
|
will show you how.
|
|
|
|
::::{grid} 2
|
|
:gutter: 3
|
|
|
|
:::{grid-item-card} [Tutorials](tutorials/index.md)
|
|
|
|
Just getting started with PyScript?
|
|
|
|
Check out our [getting started guide](tutorials/getting-started.md)!
|
|
:::
|
|
:::{grid-item-card} [How-to guides](howtos/index.md)
|
|
|
|
**Coming soon!**
|
|
|
|
:::
|
|
:::{grid-item-card} [Concepts](concepts/index.md)
|
|
|
|
[What is PyScript?](concepts/what-is-pyscript.md)
|
|
|
|
:::
|
|
:::{grid-item-card} [Reference](reference/index.md)
|
|
|
|
**Coming soon!**
|
|
|
|
:::{toctree}
|
|
:maxdepth: 1
|
|
|
|
:::
|
|
::::
|
|
|
|
```{toctree}
|
|
---
|
|
maxdepth: 1
|
|
hidden:
|
|
---
|
|
tutorials/index
|
|
howtos/index
|
|
concepts/index
|
|
reference/index
|
|
```
|