Docs/evaluator pages #253
Docs/evaluator pages #253
Conversation
- docs/autogeneartion/pages/evaluators.py creates all the rst pages based on docstrings - Updated formatting of docstrings in most of the evaluators
|
Docs currently failing to build https://readthedocs.org/projects/credoai-lens/builds/18676291/ |
|
@esherman-credo General comment: the autogeneration of evaluator pages is disables, since it adds Lens dependency to RTD. |
Noted |
| After pushing to github, Read the Docs will build the documentation if the | ||
| branch is currently activated. | ||
|
|
||
| For local build, on top of the previous commands, run `make html`directory and the docs site will build to: `docs/_build/html/index.html`, which can be opened in the browser. |
There was a problem hiding this comment.
Should add instructions for what to do if you can't auto-build, since that's the current state of things.
What is the process for putting locally-built docs onto RTD manually?
What is necessary to go back to a state where we can auto-generate/auto-push to RTD?
There was a problem hiding this comment.
Should add instructions for what to do if you can't auto-build, since that's the current state of things.
@esherman-credo do you mean in case RTD build fails?
What is the process for putting locally-built docs onto RTD manually?
You mean loading the local build directly to RTD? I don't think there is a way to do that. If the build works locally, in general it should work remotely, bar dependency issues. There shouldn't be a need for this.
What is necessary to go back to a state where we can auto-generate/auto-push to RTD?
It would be necessary to add Lens as a dependency, which is pretty onerous for just a doc build. This is due
to the code in the evaluators page generator being dependent on build_list_of_evaluators and the internal structure of the Lens package. We could find maybe some workaround, atm I think we are OK with the current manual approach.
There was a problem hiding this comment.
Ah forgive me. I was under the impression something wasn't building on RTD and that you had to upload manually. Based on discussion last week Wed or Fri.
It seems by "manual" you mean parsing the files rather than importing?
There was a problem hiding this comment.
Yeah running the parsing manually before pushing to github.
Added evaluator schema + evaluators pages
docs/pages/evaluiators/make_your_own.rstdocs/autogeneration/pages/evaluators.py