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

API docs have general module documentation after submodules #2275

Closed
pekkaklarck opened this issue Dec 21, 2015 · 2 comments
Closed

API docs have general module documentation after submodules #2275

pekkaklarck opened this issue Dec 21, 2015 · 2 comments

Comments

@pekkaklarck
Copy link
Member

API docs at http://robot-framework.readthedocs.org/ currently have general module docs after submodule docs. See, for example, http://robot-framework.readthedocs.org/en/2.9.2/autodoc/robot.result.html. This is annoying especially because we have useful examples in these general docs. For example, the previous module has examples at http://robot-framework.readthedocs.org/en/2.9.2/autodoc/robot.result.html#module-robot.result.

I think general docs were before submodule docs earlier but the order changed at some point. It turned out that it is easy to configure this by passing --module-first to sphinx-apidoc tool we use. The reason I haven't noticed it earlier is that it isn't currently documented: sphinx-doc/sphinx#2190

@pekkaklarck
Copy link
Member Author

@pekkaklarck
Copy link
Member Author

Related to this, should also have docs of the methods, attributes, etc. in source order, not in alphabetical order.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant