Introduction

This repository is for documenting about metatron-discovery.

How to build and update the contents

  • Requirements

    • Python 3 + pip
  • Clone this repository

       git clone https://github.com/metatron-app/metatron-doc-discovery.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
  • Translate to English

    • Our docs is written in Korean first. For Eng, you need to update .po files in locales/en/..
    • Update po files after changing rst files.
         make gettext
         sphinx-intl update -p docs/gettext -l en
    • For Eng docs image, put .en at the end of the image file name.
    • Eng HTML files are located in docs/en/ after building
  • Build documents using Sphinx

      make all
      make en  //When building english version only.
  • HTML files are located in docs/ directory.

  • Update

      git pull //Get the latest updates from remote repo before your commit.
      git add .
      git commit -m "commit message"
      git push

References