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

docs: No code fence and the official myst VSCode extension. #213

Merged
merged 1 commit into from
Oct 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
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
2 changes: 1 addition & 1 deletion .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
{
"recommendations": [
"DavidAnson.vscode-markdownlint",
"ExecutableBookProject.myst-highlight",
"PascalReitermann93.vscode-yaml-sort",
"charliermarsh.ruff",
"ms-python.black-formatter",
"ms-python.mypy-type-checker",
"ms-python.python",
"richie5um2.vscode-sort-json",
"shd101wyy.markdown-preview-enhanced",
"streetsidesoftware.code-spell-checker",
"trond-snekvik.simple-rst"
]
Expand Down
7 changes: 0 additions & 7 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,10 +52,3 @@
# https://autodoc-pydantic.readthedocs.io/en/stable/users/configuration.html

autodoc_pydantic_settings_show_json = False

# -- Options for myst-parser -------------------------------------------------
# https://myst-parser.readthedocs.io/en/latest/configuration.html

myst_enable_extensions = [
"colon_fence",
]
18 changes: 8 additions & 10 deletions docs/dev/env.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

After generating the project via `copier`, several necessary tools can be installed with the following commands.

:::{note}
```{note}
Using `pipx` for management is recommended and you can find pipx's installation instructions [here](https://pypa.github.io/pipx/installation/).
:::
```

```bash
# Pipenv: Virtual environment and package manager for Python.
Expand All @@ -17,9 +17,9 @@ pipx install pre-commit

## Environment Setup

:::{note}
```{note}
A universal `Makefile` is located at the root directory of the repo, and all `make` related commands are supposed to run there.
:::
```

There is an all-in-one command to setup environment for daily development.

Expand Down Expand Up @@ -57,9 +57,9 @@ make deepclean

With this command, the repo will be as if it has been re-cloned. It is useful if we want to start almost from scratch.

:::{caution}
```{caution}
This will remove all untracked files, please use it with caution. It is recommended to check with dry-run mode (`git clean -dfnx`) before actually removing anything. For more information, please refer to the [git-clean documentation](https://git-scm.com/docs/git-clean).
:::
```

```bash
git clean -dfx
Expand Down Expand Up @@ -115,13 +115,11 @@ recommended for scenarios like test CI/CD process.
make dev-test
```

:::{admonition} Install a combination of the optional dependencies
````{admonition} Install a combination of the optional dependencies
:class: tip, dropdown

For example, to install requirements for `docs` and `lint`, we can use the following command.

```bash
make dev-docs,lint
```

:::
````
2 changes: 1 addition & 1 deletion template/.vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
{
"recommendations": [
"DavidAnson.vscode-markdownlint",
"ExecutableBookProject.myst-highlight",
"PascalReitermann93.vscode-yaml-sort",
"charliermarsh.ruff",
"ms-python.black-formatter",
"ms-python.mypy-type-checker",
"ms-python.python",
"richie5um2.vscode-sort-json",
"shd101wyy.markdown-preview-enhanced",
"streetsidesoftware.code-spell-checker",
"trond-snekvik.simple-rst"
]
Expand Down
7 changes: 0 additions & 7 deletions template/docs/conf.py.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -52,10 +52,3 @@ autodoc_default_options = {
# https://autodoc-pydantic.readthedocs.io/en/stable/users/configuration.html

autodoc_pydantic_settings_show_json = False

# -- Options for myst-parser -------------------------------------------------
# https://myst-parser.readthedocs.io/en/latest/configuration.html

myst_enable_extensions = [
"colon_fence",
]
18 changes: 8 additions & 10 deletions template/docs/dev/env.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

After generating the project via `copier`, several necessary tools can be installed with the following commands.

:::{note}
```{note}
Using `pipx` for management is recommended and you can find pipx's installation instructions [here](https://pypa.github.io/pipx/installation/).
:::
```

```bash
# Pipenv: Virtual environment and package manager for Python.
Expand All @@ -17,9 +17,9 @@ pipx install pre-commit

## Environment Setup

:::{note}
```{note}
A universal `Makefile` is located at the root directory of the repo, and all `make` related commands are supposed to run there.
:::
```

There is an all-in-one command to setup environment for daily development.

Expand Down Expand Up @@ -57,9 +57,9 @@ make deepclean

With this command, the repo will be as if it has been re-cloned. It is useful if we want to start almost from scratch.

:::{caution}
```{caution}
This will remove all untracked files, please use it with caution. It is recommended to check with dry-run mode (`git clean -dfnx`) before actually removing anything. For more information, please refer to the [git-clean documentation](https://git-scm.com/docs/git-clean).
:::
```

```bash
git clean -dfx
Expand Down Expand Up @@ -115,13 +115,11 @@ recommended for scenarios like test CI/CD process.
make dev-test
```

:::{admonition} Install a combination of the optional dependencies
````{admonition} Install a combination of the optional dependencies
:class: tip, dropdown

For example, to install requirements for `docs` and `lint`, we can use the following command.

```bash
make dev-docs,lint
```

:::
````