We'd like the library to follow other open-source releases and include auto-generated docs that showcase in Sphinx. This PR moves all the READMEs out of their code-related folders into a single buildable dir, adding additional READMEs for evaluation and fine-tuning specifically.
This is the placeholder for building the docs, not all of the content itself.
The docs are built from the index.rst file, with one pointer pointing to the README at the level above docs in readme_link.md
To test:
Pull branch
cd into docs
run make clean and make html
Check out the generated html file in the build directory on your local browser.
Next steps would be to clean up the actual content and enable building of gitpages via the docs dir in Actions.
We'd like the library to follow other open-source releases and include auto-generated docs that showcase in Sphinx. This PR moves all the READMEs out of their code-related folders into a single buildable dir, adding additional READMEs for evaluation and fine-tuning specifically.
This is the placeholder for building the docs, not all of the content itself.
The docs are built from the
index.rstfile, with one pointer pointing to the README at the level abovedocsinreadme_link.mdTo test:
docsmake cleanandmake htmlNext steps would be to clean up the actual content and enable building of gitpages via the
docsdir in Actions.cc @mozilla-ai/ml-group