Change Log/History

See also the GitHub Releases page

v1.0.0+wwfx.1.0.0

Updated documentation on how to use this documentation tool.

• Fixed broken links
• Fixed incorrect .travis.yml example
• Added step by step walk-through “Getting started” page

v1.0.0+wwfx.0.4.1

Fixed docs auto-regenerate as --detach actually disabled auto-regenerate. Re-written preview docs generations to fix this.

• serve_docs.sh:
  • Directly generating from $SOURCE rather than symlink and using $TMP_BUILD_FOLDER
  • Using localhost address to fix IP address switching when browsing
  • No longer using --detach
  • More info output during setup
• preview_docs.sh:
  • Moved “Documentation built” instruction back into here
  • Switched to while true from until
• Dockerfile:
  • _doc_generator_tmp/markdown_src gets created here instead of in serve_docs.sh

v1.0.0+wwfx.0.4.0

Upgraded preview_docs.sh to enable live local preview on refresh.

• Switched to use new serve_docs.sh
• preview_docs.sh can now take in explicit URL_PATH arg
• build_docs.sh now uses --plugins instead of copying _plugins folder, minor echo tidy

v1.0.0+wwfx.0.3.1

Minor fixes:

• build_docs.sh: Inaccurate echo statements
• get-tk-core-packages.sh: Syntax error related to extra -o in if statement
• preview_docs.sh: Can now be run anywhere, including within tk-doc-generator

v1.0.0+wwfx.0.3.0

Functional improvements and fixes from testing tk-doc-generator (locally using preview_docs.sh and on travis.ci) with tk-katana on the ci-docs branch/PR. See also tk-katana’s gh-pages

• Dockerfile:
  • Moved Gem* from /app to /usr/local/src.
    • Keeps /app clean for docker run.
  • Added default ENTRYPOINT to run build_docs.sh.
  • Added tk-core as Sphinx conf.py requires it.
  • Optimised yum install packages, Ruby curl/untar.
  • Using nproc, replacing hard-coded jobs count.
• preview_docs.sh:
  • Support -v instead of --mount for docker run when using older docker version shipped with CentOS 7.
  • Will not re-build Docker image if tk-doc-generator image exists.
    • Force rebuild using preview_docs.sh --rebuild.
• build_docs.sh: Fixed configurations using absolute paths.
• Gemfile*: Using WWFX just-the-docs with new external links test

v1.0.0+wwfx.0.2.0

• Changed all/most docs links to WWFX UK versions.

• Altered shield badges to use docs label:

    [![Doc Generator](https://img.shields.io/badge/docs-WWFX%20SG%20Doc%20Generator-blue.svg)](http://github.com/wwfxuk/tk-doc-generator)
  

v1.0.0+wwfx.0.1.0

Added this change log as well as minor fixes:

• .travis.yml: Changed to WWFX UK DOC_URL
• Dockerfile: Fixed yum clean all from being part of the yum install arguments
• build_docs.sh: Fixed permissions of generated docs from just root only
• travis-generate-docs.py: Fallback to DOC_* before using dummy URL.

v1.0.0

Initial release from Shotgun, nothing mentioned by Shotgun.