search

facebook / Ax

Adaptive Experimentation Platform
https://ax.dev
MIT License
2.38k stars 312 forks source link

[GENERAL SUPPORT]: Missing Ax API Documentation #2971

Open loggy01 opened 1 month ago

loggy01 commented 1 month ago

Question

When clicking on the API button of the Ax homepage, it takes you to the following webpage: https://ax.dev/api/service.html.

Some, but not all, hyperlinked APIs take you to empty pages or a page with just subtitles. For example, this is apparent on the page for ax.service: https://ax.dev/api/service.html.

This wasn't always the case, so, do you know when information will be added back to these webpages?

Please provide any relevant code snippet if applicable.

No response

Code of Conduct

CristianLara commented 1 month ago

Hi @loggy01 thank you for raising this.

We've fixed the api documentation but it won't be on the stable version until our next release. For now please view the "latest" version of our docs using the version switcher in the top right, or go directly there using https://ax.dev/versions/latest/index.html

Adi6501 commented 3 weeks ago

So much missing content on the Ax documentation pages, including ax.service-they must be caused by Sphinx rendering issues: A tool for generating documentation for the Ax project. These had already affected a significant number of parts of the Ax API documentation, and one of the GitHub issues reported that Sphinx would not load a number of the modules because of dependency and import errors. The development team for Ax is working through these issues, and users have suggested some possible solutions, such as modifying the mocked imports list in the Sphinx configuration to skip failing modules during documentation builds.

i could try to help if i was grantted time