-
Notifications
You must be signed in to change notification settings - Fork 1
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
131 add mkdocstrings to docu #134
base: develop
Are you sure you want to change the base?
Conversation
@JFRudzinski maybe you want to take a look on this and give improvement feedback. I was also thinking that this docu generated shows that we need to describe better our objects. |
just a note to the others: after I did uv pip install -r requirements_docs.txt I get |
|
Sorry, I didn't see at first your comment about formatting. I would suggest maybe something like: name (Quantity(str)): Not sure about for the ELN stuff |
fixed a few things: #142 mostly I just added open is new browser tab for links to external sites |
I definitely agree about improving the descriptions. I think for me it would be easiest to adjust the format first so that the description is easier to read, and then I could start going through and trying to make things more consistent/descriptive and tagging things that are unclear. I could start this sooner, but then I would probably just go through the code and not use the docs. I think the former is better though cause then we can start utilizing the admonitions within the descriptions as mentioned above What do you think? |
Yeah, agreed. I will take a look on formatting better this mkdocs page. And then we improve the descriptions in a subsequent pr so the docu will show nicely the results. |
Co-authored-by: jrudz <[email protected]>
Pull Request Test Coverage Report for Build 11180180474Details
💛 - Coveralls |
@JFRudzinski I was playing with MkDocs a bit more in another context, I think I can improve the documentation in this pr. However, I wondered whether we are going to change the classes too much to make even sense. I guess we could discuss this next year in a meeting with the others like you suggested. |
Oh ok, nice. I would very much like to learn about this (for other plugin docs as well). But yeah I agree we should wait till things are a bit more stable. And yes, let's set a meeting starting next year, I will contact you. |
@JFRudzinski @Bernadette-Mohr or @EBB2675 @ndaelman-hu, would you mind taking a look?
You can locally launch the MKDocs page (check the README instructions), and see the new
References
section. Bear in mind we can change the style, but I do not want to spend to much time on this before deciding how the layout of the references should look like.