You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
m1cr0man 4a534d2404
Fix docs link errors (#167)
1 month ago
.github/workflows Add idrac NIC setup (#150) 5 months ago
docs Fix docs link errors (#167) 1 month ago
.gitignore Update mail docs (#143) 1 year ago
.markdown.style.rb update bitlbee docs for meth migration 5 months ago
.readthedocs.yml fix read the docs config (#123) 1 year ago
Makefile add html linter to make file 9 months ago
README.md Make setup automatic in build file and only rebuild site when content changes 9 months ago
mkdocs.yml Add rbbackup docs (#166) 1 month ago
requirements.txt update mkdocs and dependencies 9 months ago

README.md

Docs

Documentation Status Build and Validate

Documentation for Redbrick

Available at docs.redbrick.dcu.ie and at the readthedocs.

Docs are automatically deployed on commit to master to readthedocs

The docs are built using mkdocs.

Testing locally

When you make a change make sure it works by building it locally.

Run:

make build

This will test the docs build and if there are any dead links in them

To lint the Markdown locally, use this command (downloads very fast):

make lint

To bring up a local server with a copy of the docs just run

make serve