Commit Graph

24 Commits

Author SHA1 Message Date
Jannis Leidel
6898daf0ce Documentation infrastructure. (#262)
* 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>
2022-05-17 12:08:06 -05:00
Kevin Goldsmith
825c63c184 update contributing
point to the contributing doc
2022-05-09 10:34:36 -07:00
ic-768
eb711ec0ee README wording improvements (#301) 2022-05-09 10:05:53 -05:00
Ukeje Chukwuemeriwo Goodness
7c85e81659 Changed tl; dr to summary (#216) 2022-05-05 13:02:47 -05:00
Raúl Cumplido
e6e85acbfc [MINOR] Add full path to examples on README (#148)
* Add full path to examples on README

* Update relative path to show examples and readme

* Remove /, add link to pyscriptjs/examples

Co-authored-by: Peter W <34256109+pww217@users.noreply.github.com>
2022-05-03 13:25:09 -05:00
Andrea Stagi
ecb4b08103 chore: add syntax highlight to readme (#160) 2022-05-03 13:18:42 -05:00
Ruibin Liu
c0a263ab43 Get the GETTING-STARTED link work
Instead of square brackets, parentheses should be used.
2022-05-02 20:36:47 -04:00
Fabio Pliger
378e3ef08b Merge pull request #72 from msaroufim/docs
README and getting started updates
2022-05-02 19:26:19 -05:00
Brett Cannon
321723db9f Fix grammar in README 2022-05-02 14:01:53 -07:00
Mark Saroufim
f16b1d8c0a Merge branch 'main' into docs 2022-05-02 09:27:02 -07:00
Fabio Pliger
7fcdd8051f Merge pull request #73 from cknoll/main
Update README.md: fix typos
2022-05-01 01:04:44 -05:00
Mark Saroufim
c3345b38d2 Merge branch 'main' into docs 2022-04-30 22:58:04 -07:00
Fabio Pliger
d72ac2fcc6 Merge pull request #71 from pyscript/fix-lib-location
update script and css location temporarily
2022-05-01 00:54:37 -05:00
Mark Saroufim
d1d3ac4819 Update README.md 2022-04-30 18:41:09 -04:00
C. Knoll
4d1d11d362 Update README.md: fix typos
append "s" for 3rd person singular
2022-04-30 23:44:38 +02:00
Mark Saroufim
d55ac92e6c README and getting started updates 2022-04-30 17:02:03 -04:00
Kevin Goldsmith
8f5c848968 Update README.md
added links
2022-04-30 13:01:39 -07:00
Chris Alvarado
3da33d5bba update script and css location temporarily 2022-04-30 13:31:15 -06:00
Jannis Leidel
477b80b170 Update file structure to fit recommended patterns.
This also removes the org-docs files since we’re tracking that in pyscript/governance now. PR: https://github.com/pyscript/governance/pull/1
2022-04-29 18:02:58 +02:00
Sophia Yang
51c2efd601 Update README.md
fixed two typos
2022-04-16 21:07:44 -05:00
Fabio Pliger
957b155bd0 Merge branch 'main' into out-of-box 2022-04-01 10:53:30 -05:00
Russell Keith-Magee
2966002e44 Add some docs a links to improve the out-of-box experience. 2022-04-01 14:30:15 +08:00
Fabio Pliger
a2f2cd30a0 add minimal info the README file 2022-03-29 13:03:05 -05:00
Fabio Pliger
bc5875790c Initial commit 2022-02-20 22:55:21 -06:00