Create WDL documentation using Markdown.
Project description
wdldoc
Convert WDL documentation to Markdown for rendering.
Request Feature
·
Report Bug
·
⭐ Consider starring the repo! ⭐
Notice
This repository is still in development!
📚 Getting Started
Installation
Currently, only local setup is supported using Python 3.8 or higher:
pip install poetry>=1.0.5
poetry install
🖥️ Development
If you are interested in contributing to the code, please first review our CONTRIBUTING.md document. To bootstrap a development environment, please use the following commands.
# Clone the repository
git clone git@github.com:stjudecloud/wdldoc.git
cd wdldoc
# Install the project using poetry
poetry install
# Ensure pre-commit is installed to automatically format
# code using `black`.
brew install pre-commit
pre-commit install
pre-commit install --hook-type commit-msg
📝 License
Copyright © 2020 St. Jude Cloud Team.
This project is MIT licensed.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
wdldoc-1.0.0a0.tar.gz
(3.7 kB
view hashes)
