Changelog

0.9.15 - 2022-02-02

  • Browsers will cache the top-level index.html when publishing to S3, causing the browser to redirect to old documentation even if newer documentation has been published. This patch adds metadata to index.html to tell the browser not to cache the file.

0.9.14 - 2022-02-02

  • Browsers will caching versions.json, causing erroneous warning about not being on the latest version of the docs when new docs are published. This patch forces browsers to not cache versions.json.

0.9.13 - 2022-02-02

  • The following strings will be substituted in .rst files:

Token Value
repo_docs_dash_build The value passed to --build with "-" prepended. Example: "-internal". Empty string by default.
repo_docs_version The version number. Example: "0.8.1"
repo_docs_project The project name. Example: "carbonite"
repo_docs_config The build config. Example: "debug"

All token should be enclosed in ${}. For example: ${repo_docs_blah}.

0.9.12 - 2021-12-08

  • CSS: Large TOC’s with many sub-headings now scroll correctly.

0.9.11 - 2021-11-15

  • Fix issue #34 - --status coverage was failing (added unit tests as well)

0.9.10 - 2021-11-03

  • Output sphinx warnings into separate file. Print and publish it to TC.

0.9.9 - 2021-10-28

  • The version warning HTML element is no longer shown if versions.json does not include the latest key.

0.9.8 - 2021-10-28

  • Add automatic generation of options for version selector, disable via version_selector_enabled in repo.toml.

  • Fixed link to the latest docs in the “These docs aren’t the latest” HTML element when the current page is in a sub-directory.

0.9.7 - 2021-10-26

  • Split extra_sys_paths into python_paths and library_paths and deprecate the former.

0.9.6 - 2021-10-25

  • Added Twitch social media icon to the “omniverse” set.

  • Added lookups for “twitch”, “facebook”, “bitbucket”, and “pinterest” in social_media.

  • Fix API overview page bullet lists.

  • Add -o to automatically open built docs

  • Add sphinx_dont_exclude_patterns to apply after sphinx_exclude_patterns

  • Fix support for wildcards in sphinx_exclude_patterns

  • Set LD_LIBRARY_PATH on linux same way we set PATH on windows

0.9.5 - 2021-09-15

  • Subprojects can now use Doxygen/Exhale.

  • API docs now include an exhale_api anchor.

0.9.4 - 2021-09-14

  • Fix few path handling bugs on windows, e.g. path like C:/ and c:/ were treated differently.

  • Add config to be able to change –config default.

  • Fix s3 publishing file permission error on windows

  • Add -c short for --config as all other tools have

0.9.3 - 2021-09-14

  • CSS: Center all content.

  • Add document version selector.

  • If the currently viewed documentation is not the latest documentation, add an element to the DOM to to point the user to latest documentation.

  • Add social media icons via the social_media_set and social_media settings.

0.9.2 - 2021-09-08

  • Fix leading spaces in .gitlab-ci.yml publishing examples.

0.9.1 - 2021-09-07

  • Add optional region setting in toml file for publishing to S3.

0.9.0 - 2021-09-01

  • Breaking: Changed doxygen_additional_conf to doxygen_conf_extra and documented it to better conform with repo_docs as a whole.

0.8.2 - 2021-09-01

  • Added doxygen_additional_conf so that a programmer can add their own doxygen config lines.

  • Fixed a bug in doxygen_predefined

0.8.1 - 2021-08-30

  • PATH is now properly printed when debug output is enabled.

0.8.0 - 2021-08-30

  • Breaking: Removed tools from default exclusion list; projects must add it to their sphinx_exclude_patterns to exclude it.

  • Look for VERSION.md if VERSION file is not found

0.7.5 - 2021-08-24

  • Clone with --depth 1 when publishing via git.

  • Update --stage docs.

0.7.4 - 2021-08-20

  • Added a glossary to the documentation.

0.7.3 - 2021-08-20

  • Fix latest link when publishing (REQUIRES packman 6.37.2 or later)

  • Add support for publishing to AWS S3 on Windows

0.7.2 - 2021-08-18

  • Updated documentation to reflect changes made in 0.7.0.

0.7.1 - 2021-08-17

  • Fix Doxygen for Windows. It required debug developer runtime installed to run.

0.7.0 - 2021-08-16

  • Breaking: Renamed --stages to --stage and made it repeatable.

  • Breaking: Renamed --builds to --build and made it repeatable.

  • Breaking: Renamed --projects to --project and made it repeatable.

  • Breaking: Renamed publish key to editions in repo.toml for consistency with projects and builds.

  • Made --edition argument optional and repeatable.

  • Removed a direct import of packman link module (must go through packmanapi)

0.6.1 - 2021-06-21

  • Fixed packaging.

0.6.0 - 2021-06-21

  • Breaking: Removed short_name. Use project instead.

  • Breaking: Removed long_name. Use name instead.

  • Breaking: Removed --sphinx, --exhale, --doxygen. Use --stages instead.

  • Changed: The default output directory is now _build/docs intead of _docs.

  • Multiple projects now supported in a single repo.

    • Added --projects

  • Multiple build flavors (e.g. internal, public) can be defined.

    • Added --builds

  • publish stage can now publish your docs.

    • Added --edition. Use this to specify where/how to publish your docs.

    • Added --publish-as-latest. Updates the “latest” link on the website to the docs being published.

    • Added --publish-no-push. Gets everything ready for publishing, but stops at uploading the website.

0.5.6 - 2021-05-07

  • Added deps config key. Allows linking to other documentation projects via InterSphinx.

0.5.5 - 2021-05-05

  • Fixed bugs centered around assuming Doxygen was enabled.

  • Fixed tabs in generated conf.py.

  • Allow substitution of {config} and {platform_target} in python_path.

  • Add doxygen_predefined setting.

0.5.4 - 2021-05-03

  • Added --coverage flag. Print percent of repo headers processed by Doxygen.

0.5.3 - 2021-04-28

  • When specifying --doxygen=0 fix error due to Windows not being able to delete the temporary doxygen.conf file.

0.5.2 - 2021-04-24

  • :download: styling.

  • Bullet (>) fixes on Firefox.

0.5.1 - 2021-04-21

  • More info logging.

0.5.0 - 2021-04-21

  • Added --platform-target, which can be used to find cross-compiled .py and .pyd files.

0.4.1 - 2021-04-21

  • Package missing documents in docs/.

0.4.0 - 2021-04-20

  • Breaking: Removed doxygen_enabled. doxygen_input is now used to enable Doxygen.

  • ${config} support in extra_sys_paths.

0.3.0 - 2021-04-20

  • Revert back to din-2014 font.

  • Table CSS fixes.

  • Added asterisks .rst role.

0.2.0 - 2021-04-16

  • Improved Windows support.

0.1.0 - 2021-04-15

  • Initial release