Skip to content

Api documentation #23

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

Closed
wants to merge 2 commits into from
Closed

Api documentation #23

wants to merge 2 commits into from

Conversation

cadenmyers13
Copy link
Contributor

No description provided.

Copy link

github-actions bot commented Oct 7, 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

bobleesj commented Oct 7, 2024

looks good - the API package rendering nicely??

@cadenmyers13
Copy link
Contributor Author

looks good - the API package rendering nicely??

no docstrings present in the source files so there's nothing to build

Copy link
Contributor

@sbillinge sbillinge left a comment

Choose a reason for hiding this comment

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

please see inline. We will need an issue created to make docstrings! This can be a project for a newbie in the future, but we need to make an issue now so we don't forget.

:show-inheritance:
:titlesonly:

diffpy.fourigui.dist
Copy link
Contributor

Choose a reason for hiding this comment

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

Please check this. I doubt we want most of these in the documentation. Also, let's check how they got here....was it a problem with the API process that is also affecting other packages or something that went wrong locally?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@sbillinge The API section of the cookiecutter generates documentation for all files (see screenshot, not all files are listed). Not quite sure how to handle this. I will discuss with others
Screenshot 2024-10-08 at 11 00 18 AM

Copy link
Contributor

Choose a reason for hiding this comment

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

Just to double check:

Did you run the following?

python ../../release-scripts/auto_api.py diffpy.fourigui ./src/diffpy/fourigui ./doc/source/api

Copy link
Contributor

Choose a reason for hiding this comment

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

I am afraid it is due to the relative path issue. If you have the same problem, let's figure this out.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

got it working. I had the ./src/diffpy/fourigui as just .. Will create a new PR

@cadenmyers13 cadenmyers13 deleted the api branch October 11, 2024 20:51
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.

3 participants