Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[GENERAL SUPPORT]: Missing Ax API Documentation #2971

Open
1 task done
loggy01 opened this issue Oct 28, 2024 · 2 comments
Open
1 task done

[GENERAL SUPPORT]: Missing Ax API Documentation #2971

loggy01 opened this issue Oct 28, 2024 · 2 comments
Assignees
Labels
question Further information is requested

Comments

@loggy01
Copy link

loggy01 commented Oct 28, 2024

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

  • I agree to follow this Ax's Code of Conduct
@loggy01 loggy01 added the question Further information is requested label Oct 28, 2024
@CristianLara CristianLara self-assigned this Oct 28, 2024
@CristianLara
Copy link
Contributor

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
Copy link

Adi6501 commented Nov 10, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

3 participants