Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

  • Things to be corrected in markdowns
    • Markdown issues
      • Removal of manual

...

      • heading numbers
      • Removal of heading numbers from links (replace "[0-9]+\-" with "")
      • Replace raw

...

      • html to markdown
        • images
        • br-s
        • Image captions ()
        • other <p>-s
        • remove internal references (html anchors)
    • Markdown best praciices
      • remove the ToC-s
    • Things needed for the conversion
      • Add blank lines before lists (like here)
    • Remove the bogometers from the chapters
  • After the rst converison
    • Re-align the table line breaks
    • Move the (n)-s to supertext (if possible)


  • Generate heading during the build
  • 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
  • consistent use of intra-document linking to auto-generated

...

  • header anchors without including header numbers


Document responsibles

DocumentResponsibleMarkdown correctionsConversion to rstSeparate buildCorrection of linksLinewrap to 120
RMN/Apr mergeddone, build issues resolved.
RA1DoneDoneDonepull/2856: Done

Done

RA2pr createdpr mergedpr opened by Cedric Ollivier
RI1N/Apr mergeddone

Cedric Ollivier is working on it

RI2Georg KunzN/Apr merged

done


#2965
RC1DoneDonedonedoneAlready wrapped
RC2Cedric OllivierDoneDonedonedoneAlready wrapped
Commonpr createdpr created


All index.rst-s and files outside of subproject scopes