You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

Intro

Anuket specifications are written in GFM (GitHub flavored Markdown) what is a pretty weak markdown language (e.g.: It is not possible to scale images). These documents have three "output formats":

  1. Readthedocs uses recommonmark to convert the documents to rst in compile time. Recommonmark is not supported anymore and should be changed to something else anyways.
  2. GitHub "code view". Here GFM is the default format, but GitHub can render rst also without any problem.
  3. Some of the documents are converted to word document and published by GSMA. Conversion fomr rst would be less difficult than form md

For these reasons we would like to convert the documents from markdown to rst. This page contains information and status progress for this work.

Issues

There are some issues what we need to solve on top of converting the documents.

  1. Removal of manual headings
  2. Generate heading during the build
  3. Removal of raw html tags
  4. Removal of manual ToC-s
  5. fixing of broken intra-document links to GitHub generated anchors. These references/links only work on GitHub, but are broken in the Rtd builds already today
  6. consistent use of intra-document linking to auto-generated header anchors without including header numbers


Document responsibles

DocumentResponsible
RM
RA1
RA2
RI1
RI2Georg Kunz
RC1
RC2
Common
  • No labels