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

[WIP] Documentation & BaseDataClass Tutorial #34

Merged
merged 31 commits into from
Jun 6, 2024
Merged

[WIP] Documentation & BaseDataClass Tutorial #34

merged 31 commits into from
Jun 6, 2024

Conversation

Alleria1809
Copy link
Contributor

This update:

  1. fix some warnings and errors for easier console debugging output
  2. add autosummary tables to components by using sphinx-apidoc with a template, and hardcode inputs in a script to remove the unnecessary files before building HTML. There might be better automatic methods, but this is the best I can do for now. Will improve when I get other solutions.
    image
    image

Alleria1809 added 21 commits June 3, 2024 17:33
@Alleria1809
remove the duplicated copy
a682836
@Alleria1809
add the template for summary table
5a6e62e
@Alleria1809
fix a docstring generation error
91e37a7
@Alleria1809
adjust the header line length to reduce warnings, for easier debugging
30a81b6
@Alleria1809
update the tutorial
e28a720
@Alleria1809
add summary table to the doc
c067db9
@Alleria1809
update api generation
9e53ee1
@Alleria1809
update reference
60d34bf
@Alleria1809
update script name
93a4690
@Alleria1809
update the file removal
db575f6
@Alleria1809
update makefile
588c125
@Alleria1809
Merge remote-tracking branch 'origin/main' into xiaoyi_doc
af7076f
@Alleria1809
remove community
94fbc48
@Alleria1809
update example presenting
e656d4b
@Alleria1809
update example presenting
cb61709
@Alleria1809
update dataclass example code
9bc56ea
@Alleria1809
upload the basedataclass tutorial, need to add a generator/prompt exa…
648c730 
…mple
@Alleria1809
update the tutorial
9664fc7
@Alleria1809
update the dataclass tutorial
9ae844b
@Alleria1809
update the dataclass docstring
e256f0b
@Alleria1809
update the dataclass docstring
1daba20
@Alleria1809 Alleria1809 changed the title [WIP] Documentation [WIP] Documentation & BaseDataClass Tutorial Jun 5, 2024
liyin2015
liyin2015 approved these changes Jun 6, 2024
View reviewed changes
Copy link
Member

@liyin2015 liyin2015 left a comment

Choose a reason for hiding this comment

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

Looks good for now, lets merge!

@Alleria1809 Alleria1809 merged commit f4c7bda into main Jun 6, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@liyin2015 liyin2015 liyin2015 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
@Alleria1809 @liyin2015