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

Fix doc generation #34

Merged
merged 2 commits into from
Aug 30, 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 .github/workflows/gh-pages.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ jobs:

env:
MDBOOK_VERSION: 0.4.21 # https://github.com/rust-lang/mdBook/releases
TERA_VERSION: 0.2.2 # https://github.com/chevdor/tera-cli/release
TERA_VERSION: 0.2.4 # https://github.com/chevdor/tera-cli/release

steps:
- name: Checkout sources
Expand Down
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# labels

The repo contains specifications related to labels in the `substrate`, `polkadot` and `cumulus` repos.
It uses [ruled_labels](https://github.com/paritytech/ruled_labels) to defined the rules about requirements and interactions between labels. The rules and tests are for all repos the same, only the labels differ for each repo.
The repo contains specifications related to labels for the `polkadot-sdk` repo.

If you need more information, check out the documentation at [https://paritytech.github.io/labels](https://paritytech.github.io/labels).
It uses [ruled_labels](https://github.com/paritytech/ruled_labels) to define the rules, requirements and interactions between labels.
The rules and tests are for all repos the same, only the labels differ for each repo.

For more information, check out the generated documentation at [https://paritytech.github.io/labels](https://paritytech.github.io/labels).
4 changes: 1 addition & 3 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,5 @@
[Home](HOME.md)

- [Respositories](#)
- [Polkadot](doc_polkadot.md)
- [Cumulus](doc_cumulus.md)
- [Substrate](doc_substrate.md)
- [Polkadot SDK](doc_polkadot-sdk.md)
- [FAQ](faq.md)
6 changes: 3 additions & 3 deletions scripts/build-doc.sh
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ export COMMIT=$(git rev-parse HEAD)

mkdir -p ./docs/src

chains=$1
chains=${chains:-"substrate polkadot cumulus"}
repo=$1
repo=${repo:-"polkadot-sdk"}

for chain in $chains; do
for chain in $repo; do
echo "Generating doc for $chain..."
tera --include --env --env-key env --template templates/template.md.tera ruled_labels/specs_${chain}.yaml >./docs/src/doc_${chain}.md
done