https://github.com/pyscript/docs
The source code for the official documentation of PyScript.
https://github.com/pyscript/docs
Last synced: about 2 months ago
JSON representation
The source code for the official documentation of PyScript.
- Host: GitHub
- URL: https://github.com/pyscript/docs
- Owner: pyscript
- Created: 2023-09-11T18:49:02.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-11T12:08:19.000Z (9 months ago)
- Last Synced: 2025-04-07T11:01:27.180Z (8 months ago)
- Language: JavaScript
- Homepage: https://docs.pyscript.net
- Size: 3.99 MB
- Stars: 12
- Watchers: 6
- Forks: 13
- Open Issues: 42
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
Awesome Lists containing this project
README
# PyScript documentation
Welcome to the PyScript documentation repository.
This source code becomes the official PyScript documentation hosted here:
[https://docs.pyscript.net](https://docs.pyscript.net/)
Contribute prose and participate in discussions about the written support of
PyScript and related topics.
## Getting started
Before you start contributing to the documentation, it's worthwhile to
take a look at the general contributing guidelines for the PyScript project.
You can find these guidelines here
[Contributing Guidelines](https://github.com/pyscript/pyscript/blob/main/CONTRIBUTING.md)
## Setup
The `docs` directory in the pyscript repository contains a
[Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)
documentation project. Material is a system that takes plaintext files
containing documentation written in Markdown, along with static files like
templates and themes, to build the static end result.
To setup the documentation development environment simply create a new
virtual environment, then `pip install -r requirements.txt` (from in the root
of this repository).
```sh
# example of a simple virtual environment
# creation from the root of this project
python -m venv .
./bin/pip install --upgrade setuptools
./bin/pip install -r requirements.txt
```
## Build
Simply run `mkdocs serve` or `./bin/mkdocs serve`.
## Cross-referencing
Link to other pages in the documentation by using the `{doc}` role. For
example, to link to the `docs/README.md` file, you would use:
```markdown
{doc}`docs/README.md`
```
Cross-reference the Python glossary by using the `{term}` role. For example, to
link to the `iterable` term, you would use:
```markdown
{term}`iterable`
```
Cross-reference functions, methods or data attributes by using the `{attr}` for
example:
```markdown
{py:func}`repr`
```
This would link to the `repr` function in the python builtins.