Skip to content

docs: General todos for Markdown #5162

@wenzeslaus

Description

@wenzeslaus

This is a general todo list for the new documentation which originally lived in #3849 (I transferred the unresolved todos only). Feel free to add more basic issues here, but use smaller issues and the project for specific tasks if possible rather than turning this into a un-closeable mega issue.

Needed

Notes on man:

-$(MANDIR)/%.$(MANSECT): $(HTMLDIR)/%.html
+$(MANDIR)/%.$(MANSECT): $(MDDIR)/source/%.md

Nice to have

Future

  • revise usage of keywords and tags from user perspective (what should a reader see) docs: Replace keywords index by MkDocs tags #5446 and docs: Remove Keywords section from generated doc #5444
  • revise usage of keywords and tags from implementation perspective (valid YAML syntax and duplication) docs: Use YAML list for keywords in front matter #5320
  • remove Markdown code for generating keyword index page (possibly just remove it together with HTML)
  • revise or clean up the graphical index (index pages) - drop it or make it the only index pages
  • remove reStructuredText-related code and scripts (aka rest or rst), maybe not all of it because some of it is used (and useful) for auto-generated docstring in Python.
  • remove HTML documentation files
  • remove custom HTML documentation from build system and build scripts

Sub-issues

Metadata

Metadata

Assignees

No one assigned

    Labels

    PythonRelated code is in PythondocsmanualDocumentation related issuesmarkdownRelated to markdown, markdown files

    Type

    Projects

    Status

    In Progress

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions