2
2
3
3
Welcome to the PyScript documentation repository.
4
4
5
+ This source code becomes the official PyScript documentation hosted here:
6
+
7
+ [ https://docs.pyscript.net ] ( https://docs.pyscript.net/ )
8
+
5
9
Contribute prose and participate in discussions about the written support of
6
10
PyScript and related topics.
7
11
8
12
## Getting started
9
13
10
14
Before you start contributing to the documentation, it's worthwhile to
11
- take a look at the general contributing guidelines for the PyScript project. You can find these guidelines here
15
+ take a look at the general contributing guidelines for the PyScript project.
16
+ You can find these guidelines here
12
17
[ Contributing Guidelines] ( https://github.com/pyscript/pyscript/blob/main/CONTRIBUTING.md )
13
18
14
19
## Setup
15
20
16
21
The ` docs ` directory in the pyscript repository contains a
17
- [ Material for MkDocs] ( https://squidfunk.github.io/mkdocs-material/ ) documentation project. Material is a system
18
- that takes plaintext files containing documentation written in Markdown, along with
19
- static files like templates and themes, to build the static end result.
22
+ [ Material for MkDocs] ( https://squidfunk.github.io/mkdocs-material/ )
23
+ documentation project. Material is a system that takes plaintext files
24
+ containing documentation written in Markdown, along with static files like
25
+ templates and themes, to build the static end result.
20
26
21
27
To setup the documentation development environment simply create a new
22
28
virtual environment, then ` pip install -r requirements.txt ` (from in the root
@@ -35,19 +41,22 @@ Simply run `mkdocs serve` or `./bin/mkdocs serve`.
35
41
36
42
## Cross-referencing
37
43
38
- You can 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:
44
+ Link to other pages in the documentation by using the ` {doc} ` role. For
45
+ example, to link to the ` docs/README.md ` file, you would use:
39
46
40
47
``` markdown
41
48
{doc}`docs/README.md`
42
49
```
43
50
44
- You can also cross-reference the python glossary by using the ` {term} ` role. For example, to link to the ` iterable ` term, you would use:
51
+ Cross-reference the Python glossary by using the ` {term} ` role. For example, to
52
+ link to the ` iterable ` term, you would use:
45
53
46
54
``` markdown
47
55
{term}`iterable`
48
56
```
49
57
50
- You can also cross-reference functions, methods or data attributes by using the ` {attr} ` for example:
58
+ Cross-reference functions, methods or data attributes by using the ` {attr} ` for
59
+ example:
51
60
52
61
``` markdown
53
62
{py:func}`repr`
0 commit comments