Skip to content

User experience improvements

Nikhil Ramakrishnan requested to merge github/fork/hughmcmaster/docwriter-dirs into master

Created by: hughmcmaster

FreeType's API reference is currently produced in docs/reference/site, which is inconsistent with the rest of the documentation. The path also causes broken hyperlinks in existing documentation and the API itself.

When the static site exists in docs/reference, all hyperlinks function correctly.

I have filed a bug about various documentation issues upstream and have been asked to resolve the problems reported. Many relate to mkdocs-material and are being addressed in that project.

The patches in this PR go some way to resolving the issues identified in FreeType's documentation, although a small patch is needed. In this PR, the patches:

  • automatically create the 'markdown' directory if it does not exist in the output dir; and
  • allow users to specify the name of the static site (site_dir).

Merge request reports