Skip to main content

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for wdldoc, version 1.2.0a0
Filename, size File type Python version Upload date Hashes
Filename, size wdldoc-1.2.0a0-py3-none-any.whl (6.9 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size wdldoc-1.2.0a0.tar.gz (5.6 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page