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

Docs: Build developer docs from code #2503

Open
MattHag opened this issue May 27, 2024 · 2 comments
Open

Docs: Build developer docs from code #2503

MattHag opened this issue May 27, 2024 · 2 comments
Labels
enhancement help wanted

Comments

@MattHag
Copy link
Collaborator

MattHag commented May 27, 2024 •
edited
Loading

Some code pieces already contain docstrings, which should be automatically compiled to documentation and published with GitHub pages on a page Developer documentation.

The numpydoc format is the preferred style.
@MattHag
Copy link
Collaborator Author

MattHag commented May 31, 2024

@pfps That's something for you, as the doc creation is not public.

This was referenced Jun 8, 2024
Closed
Merged
@MattHag
Copy link
Collaborator Author

MattHag commented Jul 1, 2024

Docs should now be built from docstrings too. But it seem not everything is gathered.

MattHag added a commit to MattHag/Solaar that referenced this issue Aug 19, 2024
@MattHag
Remove incomplete developer docs
1c49d40 
Auto generated code documentation is incomplete, remove it.

Related pwr-Solaar#2503
@MattHag MattHag mentioned this issue Aug 19, 2024
Merged
pfps pushed a commit that referenced this issue Aug 23, 2024
@MattHag @pfps
Remove incomplete developer docs
af12f8d 
Auto generated code documentation is incomplete, remove it.

Related #2503
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement help wanted
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@MattHag