-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
76117a2
commit 294730a
Showing
6 changed files
with
2,525 additions
and
1,701 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
|
||
??? tip "Refresh Python dependencies in Bazel" | ||
|
||
Steps: | ||
1. `poetry add <dependency>` | ||
2. Run `./bin/poetry-export.sh` | ||
3. Use regular bazel operations, the new dependency should now be available |
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
|
||
# Documentation | ||
|
||
We use MkDocs to generate, serve, and search the team documentation. | ||
For full documentation visit [mkdocs.org](https://www.mkdocs.org). | ||
|
||
## Commands | ||
|
||
* `bazel run "//:mkdocs" new [dir-name]` - Create a new project. | ||
* `bazel run "//:mkdocs" serve` - Start the live-reloading docs server. | ||
* `bazel run "//:mkdocs" build` - Build the documentation site. | ||
* `bazel run "//:mkdocs" -h` - Print help message and exit. | ||
|
||
To generate documentation as HTML, you can use convenience script `./bin/mkdocs-build.sh`. The generated documentation will be in the `site` subdirectory of the repo root. | ||
|
||
## Project layout | ||
|
||
mkdocs.yml # The configuration file. | ||
docs/ | ||
index.md # The documentation homepage. | ||
... # Other markdown pages, images and other files. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
site_name: DRE team docs | ||
site_description: >- | ||
A collection of docs for the DRE team | ||
repo_name: core/release | ||
repo_url: https://gitlab.com/dfinity-lab/core/release/ | ||
edit_uri: edit/main/docs/ | ||
|
||
theme: | ||
name: material | ||
features: | ||
- content.action.edit | ||
- content.action.view | ||
- content.tooltips | ||
- navigation.sections | ||
- navigation.instant | ||
- search.suggest | ||
- search.highlight | ||
- search.share | ||
|
||
plugins: | ||
- search | ||
- offline | ||
|
||
# Extensions | ||
markdown_extensions: | ||
- admonition | ||
- attr_list | ||
- footnotes | ||
- toc: | ||
permalink: true | ||
- pymdownx.betterem: | ||
smart_enable: all | ||
- pymdownx.critic | ||
- pymdownx.details | ||
- pymdownx.emoji: | ||
emoji_generator: !!python/name:material.extensions.emoji.to_svg | ||
emoji_index: !!python/name:material.extensions.emoji.twemoji | ||
- pymdownx.highlight: | ||
anchor_linenums: true | ||
- pymdownx.keys | ||
- pymdownx.tabbed: | ||
alternate_style: true | ||
- pymdownx.superfences | ||
- tables |
Oops, something went wrong.