Previously, top-level enums caused the generation of filenames like
"shaka.config.html#AutoShowText" instead of
"shaka.config.AutoShowText.html". This broke the generation of docs for
top-level enums (attached to a namespace instead of a class).
This adds support for these into our jsdoc template.
Related to PR #3421
This feature is based on a forked version of jsdoc which we hope to
land https://github.com/jsdoc3/jsdoc/pull/1502 upstream.
Closes#1259
Change-Id: I48e07ffd8ae9fc2c07cd48b3e02b85e87694d341
This uses a plugin to customize certain tags in jsdoc.
In some cases, we have invented new tags in our build system.
In others, we want to the docs to treat things differently than the
build.
Issue #1259
Change-Id: I934ad578cf7479572cb807c5b3aee489c332343a
We can now specify in a config file what order the nav elements should
be in, and which nav elements should appear.
Issue #1259
Change-Id: I4caa3a0585b4140e76a66f1c5bed0c20c82ca5a4
This updates jsdoc to the latest version from npm and forks a copy of
the default jsdoc template.
In subsequent commits, we will reapply our customizations to the
template and to a jsdoc plugin.
This also fixes several bad annotations that the new jsdoc failed to
parse.
Issue #1259
Change-Id: I00a47270ea4754e1c96c43ca900d5cf889ab72e6
- Update tutorial link in README
- Fix python version in README
- Move jsdoc conf to docs/ folder
- Add API docs main page
- Change style of inline code blocks
- Don't repeat tutorial title in jsdoc template
- (makes it easier to read tutorials on github as MD)
- Add tutorials for:
- Welcome to Shaka
- Basic Usage
- Debugging
- Configuration
- Networking and Buffering Configuration
- DRM Configuration
- License Server Authentication
- Plugins
- Tutorials still to come:
- License Headers and Track Restrictions
- Special Considerations for Live
- v2 Upgrade Guide
Change-Id: I16401c216cf4023d9097750ac7f6090c68bf3c9b
Joey Parrish
Michelle Zhuo
Sandra Lokshina
Joey Parrish