AcademySoftwareFoundation / OpenTimelineIO

Open Source API and interchange format for editorial timeline information.
http://opentimeline.io
Apache License 2.0
1.44k stars 282 forks source link

Add documentation build and publish to github actions #975

Open reinecke opened 3 years ago

reinecke commented 3 years ago

Thanks to #878 we now have C++ documentation with doxygen! There are other bits of documentation that can be generated but we don't autogenerate any of it.

We should add github actions to build documentation packages and publish the artifacts.

Note: I expect this issue will need to be broken down a lot into more manageable chunks.

Description

The types of documentation we have/should have include:

Below is a proposed plan of attack, very open to discussion:

Currently, read the docs is compiling our markdown to html and publishing. Given that we have many documentation building systems, I suggest we migrate to an approach where we use github pages to publish most our generate documentation - the exception would be the python reference documentation which should be published to Read the Docs.

To achieve this, we should:

  1. Setup the root of our github pages to host most of the content currently going to Read the Docs
  2. Setup a per-language subdir in our github pages for reference docs (C++, Java, Schema, etc.)
  3. Setup generation of hand-written markdown documentation to html using MkDocs
  4. Setup generation of each auto-generated docset as a separate artifact
  5. Setup publishing generated docs to the relevant subdir in the github pages site
  6. Update the Read the Docs pages to be only the python-specific material
  7. Update the hand-written Markdown to link out to the generated sub-trees (or to read the docs for python)

This sets us up to have the github pages be our central documentation landing location and then users can be directed toward the information they need. Also it allows the file tree within our github pages to be namespaced out and allow many different sources to feed it.

As a trivial example, the site structure could be laid out as:

├── [standard mkdocs files]
├── generated
│   ├── adapters
│   ├── c++
│   ├── java
│   ├── python
│   └── specification
└── index.html

Then ownership of each directory under generated could be delegated to the actions that own publishing to those directories.

Open Questions

reinecke commented 3 years ago

Per @jminor: We should take a look at how the OpenColorIO docs are working and see what is adoptable from that.