open-sdg / sdg-build

Python package to convert SDG-related data and metadata between formats
MIT License
5 stars 23 forks source link

Documentation and support for "docs_subfolder" option #162

Closed brockfanning closed 3 years ago

brockfanning commented 4 years ago

The automated documentation has a docs_subfolder option which allows the documentation to be created in a subfolder, instead of the root of the project. There are a couple of issues:

  1. This isn't documented anywhere
  2. The automated documentation can have many relative links, which assume the document is at the root of the project. This causes broken links. We should move away from relative links and try to always use absolute. This will require some sort of "baseurl" option, like Jekyll has.