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

Add autodocs #4

Merged
merged 21 commits into from
Oct 2, 2024
Merged

Add autodocs #4

merged 21 commits into from
Oct 2, 2024

Conversation

JAB1305
Copy link
Contributor

@JAB1305 JAB1305 commented Aug 17, 2024 •
edited by s-heppner
Loading

This adds the necessary configuration files for automatically generating documentation based on the code docstrings, similarly to how it works in the BaSyx-Python-SDK Docs.

We also add a simple GitHub workflow CI job to verify the compilation of docs without errors.

Depends on #5

@JAB1305 JAB1305 marked this pull request as draft August 17, 2024 13:11
@JAB1305 JAB1305 marked this pull request as ready for review August 24, 2024 13:41
s-heppner
s-heppner requested changes Sep 6, 2024
View reviewed changes
s-heppner
s-heppner reviewed Sep 20, 2024
View reviewed changes
s-heppner
s-heppner requested changes Sep 20, 2024
View reviewed changes
Copy link
Contributor

@s-heppner s-heppner left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other than the small comment above, it lgtm now.
While you're at it, can you resolve the conflicts with the ci.yml in the main branch?

@JAB1305
Add simple sphinx setup very similar to basyx-python-sdk
8a5aaed 
Highly WIP
@JAB1305
.github/workflows: Try to add automatic html compile
b3f7e30
@JAB1305
docs/Makefile: Adjust source and build path
fc3c99a
@JAB1305
requirements.txt: Add aas-core requirement
1d8becc
@JAB1305
docs/source/conf.py: Add aas_core3 as intersphinx mapping
b6b779b
@JAB1305
sdk/basyx/object_store.py: Add temporary docstring
40fd674 
Check if this might resolve the current warnings in github workflow
@JAB1305
docs/source/conf.py: Add autodoc_typehints
72a6757 
This might be a fix for the current compile issue regarding TypeVars
@JAB1305
readthedocs.yaml: Create config, adjust project information
689f196
@JAB1305
docs: Adjust file structure
4b93f15
@JAB1305
docs/srouce/conf.py: Remove unnecessary missing ref handling
60d3252
@JAB1305
/docs: Reformat and restructure subfiles
044ce12
@JAB1305
docs/source/conf.py: Remove unused intersphinx entries
4127bb1
@JAB1305
sdk/basyx/object_store.py: Add class references to basyx-python-sdk w…
3eaad38 
…here originally removed
@JAB1305
docs/add-requirements: Add basyx-python-sdk
08f6def
@JAB1305
sdk/basyx/object_store.py: Resolve workflow error due to wrong type
22b3ad4
@JAB1305
.readthedocs.yaml: Change os version of compile container to always u…
dd530d9 
…se the newest LTS
@JAB1305
sdk/basyx/object_store.py: Resolve TODOs, add comment
9696a76
@JAB1305
docs\souce\conf.py: Use release version specified in pyproject.toml
df9754e 
This adds 'toml' as an addition requirement necessary to compile the documentation
@JAB1305
sdk/basyx/object_store: Update docstrings to aas_core3 classes
1c283d0
@JAB1305
sdk/basyx/object_store.py: Remove old references
a9f2c30
@JAB1305
/docs: Restructure dependency specification
2b629ec
@s-heppner s-heppner merged commit 5e5c5e8 into eclipse-basyx:main Oct 2, 2024
6 checks passed
@s-heppner s-heppner deleted the docs branch October 2, 2024 09:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@s-heppner s-heppner s-heppner approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@JAB1305 @s-heppner