Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ADD Doc API keys endpoints to documentation #383

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
feat: Update README.md
More explicit supported python versions

more explicit grist-checkout -> grist-core-checkout
hexaltation committed Aug 13, 2024

Verified

This commit was signed with the committer’s verified signature.
hexaltation Grégoire Cutzach
commit e9f052305b124a83cd9e166edfbd3b08e76976ad
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@ Repository for Grist documentation and tutorials.

The public site is at <https://support.getgrist.com/>, served using GitHub Pages.

The content is hosted at <https://github.com/dsagal/grist-help/>. On changes to master (such as
The content is hosted at <https://github.com/gristlabs/grist-help/>. On changes to master (such as
when a pull request is merged), the public site gets automatically republished.

Previews of pull requests are automatically built by Netlify, and made available at URLs such as
@@ -15,6 +15,8 @@ Conversation tab.

## Setting up local environment

N.B.: Python 3.12 isn't supported yet. Please, use Python 3.10 or 3.11 instead.

``` sh
# initiate a python virtual environment
python3 -m venv env
@@ -92,7 +94,7 @@ Once you're done, add the results to the main documentation with:
To update `help/en/docs/functions.md` from the documentation comments in Grist, run:

```
./build-functions.sh <path-to-grist-checkout>
./build-functions.sh <path-to-grist-core-checkout>
```

It replaces content between `BEGIN mkpydocs`/`END mkpydocs` markers in `help/en/docs/functions.md`. You
@@ -103,7 +105,7 @@ can edit text outside of those markers directly.
To update `help/en/docs/code` from the documentation comments in Grist, run:

```
./build-plugin-api.sh <path-to-grist-checkout>
./build-plugin-api.sh <path-to-grist-core-checkout>
```

You need to first run `yarn install` in your Grist checkout directory.