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

Generate usage examples for FleurXMLModifier in docs #173

Draft
wants to merge 36 commits into
base: develop
Choose a base branch
from
Draft

Generate usage examples for FleurXMLModifier in docs #173

wants to merge 36 commits into from

Conversation

janssenhenning
Copy link
Contributor

No description provided.

@janssenhenning janssenhenning added enhancement New feature or request docs Issues related to the documentation labels Jun 23, 2022
@codecov
Copy link

codecov bot commented Jun 23, 2022 •
edited

Codecov Report

Merging #173 (0f447b6) into develop (8a3c606) will decrease coverage by 0.59%.
The diff coverage is 16.41%.

Additional details and impacted files 
@@             Coverage Diff             @@
##           develop     #173      +/-   ##
===========================================
- Coverage    86.97%   86.39%   -0.59%     
===========================================
  Files          137      139       +2     
  Lines        24983    25111     +128     
===========================================
- Hits         21729    21694      -35     
- Misses        3254     3417     +163

@janssenhenning janssenhenning force-pushed the feature/usage-example-templates branch from f88dd38 to ed417ea Compare July 18, 2022 06:06
@janssenhenning janssenhenning force-pushed the feature/usage-example-templates branch 2 times, most recently from 2703811 to c73145e Compare August 10, 2022 20:55
janssenhenning and others added 23 commits May 12, 2023 10:56
@janssenhenning
Add short descriptions to setter functions
b49991a
@janssenhenning
WIP: Autogenerate Usage examples in the documentation
9cf1f65
@janssenhenning
Add more usage examples and add them to the toctree temporarily
e8b9170
@janssenhenning
Even more usage-examples
099f562
@janssenhenning
Improve template with contents and nested heading
c1dd362
@janssenhenning
Adjust colors in XML diff function
3bbd689
@janssenhenning
Move the sphinx extension stuff into a subfolder for nicer organization
2c78269
@pre-commit-ci @janssenhenning
[pre-commit.ci] auto fixes from pre-commit.com hooks
accf572 
for more information, see https://pre-commit.ci
@janssenhenning
Fixes after rebase
2c6c39c
@janssenhenning
Improve template
311e34f
@janssenhenning
Move error handling in schema_dict into function
98686c1
@janssenhenning
Move finding paths to attributes from tag names into separate method
f6a74dc
@janssenhenning
Add make step to docs to run the fleurxmlmodfier docstring write script
f204e98 
More direct feedback when changing the examples, since no additional
pre-commit step is needed in between
@janssenhenning
Delete comment from example file to reduce noise
2329d0b
@janssenhenning
More examples
bcb920f
@janssenhenning
Clearer docstring
6181779
@janssenhenning
Cleanup conf.py
a246b56
@janssenhenning
typing
3aeebd0
@janssenhenning
Start experimenting with some link layouts on the actual fleurxmlmodi…
226ca9f 
…fier site
@janssenhenning
Add references to API references
cbc89e4
@janssenhenning
Add all missing links
18e8e27
@janssenhenning
formatting
f35ec03
@janssenhenning
more
7358e62
@janssenhenning janssenhenning force-pushed the feature/usage-example-templates branch from 04d2083 to 11a9552 Compare May 12, 2023 09:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
docs Issues related to the documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
1 participant
@janssenhenning