cytomining / DeepProfiler-handbook

Documentation for installing and using of DeepProfiler
https://cytomining.github.io/DeepProfiler-handbook/
7 stars 3 forks source link
deep-learning documentation

Jupyter Book Badge

DeepProfiler Handbook

Documentation for installation and use of DeepProfiler (Jupyter Book) Website available HERE

image

How to contribute changes

1. Making issues or editing files:

From the page you want to change on the web documentation:

  1. At the top of the page, you can click the GitHub icon
  2. You can submit an issue or directly edit the markdown of the page:

image

Submit a PR

  1. Fork the repo
  2. Change the markdown documents in DeepProfiler-Handbook/docs. Here's a guide to special content blocks for Jupyter Books (notes, warnings, panels, code blocks)
  3. Submit a pull request
  4. Once changes have been pushed to this repo, the book will automatically re-build and the website will automatically deploy with the new changes

Sources for compiling this documentation