Introduction

This repository is for documenting about Metatron Discovery Install.

How to build and update the contents

• Requirements

  • Python 3 + pip

• Clone this repository

     git clone https://github.com/AnnieHwang/metatron-doc-install.git

• Install packages

    pip install -r requirements.txt

• Edit the contents

  • Every document is written in rst file. Follow the reStructedText syntax.
  • Location for all the image files is /_static/img/part00

• Build documents using Sphinx

    make html

• HTML files are located in _build/html/.

• Copy built files to docs/ for publishing GitHub Pages

    cp -r _build/html/* docs/

• Refactory

    rm -f docs/static
    rm -f docs/image
    refactor > rename (by intelliJ) : _static => static, _image => image
    cp -r docs/static/* docs/_static

• Update

    git add .
    git commit -m "commit message"
    git pull
    git push

References

• Sphinx Documents
• reStructuredText Quick Reference