Skip to content

Commit

Permalink
fix: bazel //:mkdocs
Browse files Browse the repository at this point in the history
  • Loading branch information
sasa-tomic committed Jan 4, 2024
1 parent 76117a2 commit 294730a
Show file tree
Hide file tree
Showing 6 changed files with 2,525 additions and 1,701 deletions.
7 changes: 7 additions & 0 deletions docs/bazel/tips-and-tricks.md
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 added docs/getting-started.md
Empty file.
21 changes: 21 additions & 0 deletions docs/index.md
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.
45 changes: 45 additions & 0 deletions mkdocs.yml
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
Loading

0 comments on commit 294730a

Please sign in to comment.