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.

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

Cookiecutter - generate API doc #29

Merged
merged 2 commits into from
Nov 5, 2024
Merged

Cookiecutter - generate API doc #29

merged 2 commits into from
Nov 5, 2024

Conversation

bobleesj
Copy link
Contributor

@bobleesj bobleesj commented Nov 1, 2024

Screenshot 2024-11-01 at 3 32 34 PM

Rendered locally

Closes #27

Copy link

github-actions bot commented Nov 1, 2024

Warning! No news item is found for this PR. If this is a user-facing change/feature/fix,
please add a news item by copying the format from news/TEMPLATE.rst.

@bobleesj
Copy link
Contributor Author

bobleesj commented Nov 1, 2024

@sbillinge ready for review - will fix pytest next.

@sbillinge
Copy link
Contributor

@bobleesj this seems to be failing tests. They look vaguely familiar...are they waiting for something to be merged?

@bobleesj
Copy link
Contributor Author

bobleesj commented Nov 5, 2024

@sbillinge nmf_mapping has some test functions (3 of them) that aren't testing the behavior/outputs correctly or as intended. I will write an issue regarding this. As far as docs go, I think we can merge this?

@sbillinge sbillinge merged commit 1a0714b into diffpy:main Nov 5, 2024
1 of 3 checks passed
@bobleesj bobleesj deleted the api-doc branch November 5, 2024 04:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Implement cookiecutter API workflow
2 participants