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.

Sign up for GitHub

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

Jump to bottom

Create API Reference Subpage #14

Closed
1 task
michaelweinold opened this issue Nov 7, 2022 · 10 comments
Closed
1 task

Create API Reference Subpage #14

michaelweinold opened this issue Nov 7, 2022 · 10 comments
Assignees
@michaelweinold
Labels
enhancement
Milestone
0.1.0.

Comments

@michaelweinold
Copy link
Contributor

  • update Sphinx build files to take Python docstrings from all Brightway packages (compare current implementation at brightway2).
@michaelweinold michaelweinold self-assigned this Nov 7, 2022
@michaelweinold michaelweinold added this to the 0.1.0. milestone Nov 16, 2022
@michaelweinold
Copy link
Contributor Author

Relevant Sphinx extension: autodoc

@michaelweinold
Copy link
Contributor Author

Evaluate the necessity of adding Sphinx extension: napoleon

@michaelweinold
Copy link
Contributor Author

michaelweinold commented Nov 17, 2022 •
edited
Loading

Solution 1: "copy .py files from other directories to temporary directories" (will this work on readthedocs.org also?)
Solution 2: ["mock imports"] 1
Solution 3: "simply hard-code links and add to sys.path

@michaelweinold
Copy link
Contributor Author

How is this managed in the brightway2 repository? No packages there either?!

@michaelweinold
Copy link
Contributor Author

michaelweinold commented Nov 18, 2022 •
edited
Loading

Check: apidoc
Check: autoapi

@michaelweinold
Copy link
Contributor Author

michaelweinold commented Nov 22, 2022 •
edited
Loading

Examples of readthedocs pages (likely) taking information from different repos: lino, plone

@michaelweinold
Copy link
Contributor Author

Compare my own question on StackExchange

@michaelweinold
Copy link
Contributor Author

michaelweinold commented Nov 23, 2022 •
edited
Loading

Compare my own question on StackExchange

...best option seems to be:

submodules

Examples of readthedocs pages using submodules: sphinx-with-submodules

This was referenced Nov 28, 2022
Closed
Closed
@michaelweinold
Copy link
Contributor Author

Check: apidoc Check: autoapi

Probably best to use autoapi, which is being developed by the readthedocs.org team. Offers support for languages other than Python and builds documentation from source code without the need to load packages. Would work nicely with submodules.

michaelweinold added a commit that referenced this issue Nov 30, 2022
@michaelweinold
#14 updated configuration to use autoapi
d3f3278
@michaelweinold
Copy link
Contributor Author

Initial setup completed with f5bdc90.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@michaelweinold michaelweinold

Labels
enhancement
Projects
None yet
Milestone
0.1.0.
Development

No branches or pull requests
1 participant
@michaelweinold