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

JOSS: Functionality documentation #129

Open
bonh opened this issue Feb 17, 2025 · 4 comments
Open

JOSS: Functionality documentation #129

bonh opened this issue Feb 17, 2025 · 4 comments

Comments

@bonh
Copy link

bonh commented Feb 17, 2025

I didn't try the script to generate api documentation yet. Perhaps you'd like to generate the docs and host them online? Makes scrolling easier 😄

@openjournals/joss-reviews#7710

@ebknudsen
Copy link
Collaborator

@bonh The docs that were there were an artifact of an early attempt at using readthedocs, which was not finished. They have been updated have may be browsed at https://cad-to-openmc.readthedocs.io/

@ebknudsen
Copy link
Collaborator

@bonh Thanks for commenting on that. That way it got fixed. Closing.

@bonh
Copy link
Author

bonh commented Mar 7, 2025

Thanks, that's great! But the API doc doesn't look complete?

@ebknudsen ebknudsen reopened this Mar 7, 2025
@ebknudsen
Copy link
Collaborator

Yes, for sure, this is work in progress. There's now an open issue on that subject: united-neux#21

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

No branches or pull requests

2 participants