-
Notifications
You must be signed in to change notification settings - Fork 7
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
Closed
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| :tocdepth: -1 | ||
|
|
||
| diffpy.fourigui.src.diffpy.fourigui package | ||
| =========================================== | ||
|
|
||
| .. automodule:: diffpy.fourigui.src.diffpy.fourigui | ||
| :members: | ||
| :undoc-members: | ||
| :show-inheritance: | ||
|
|
||
| Submodules | ||
| ---------- | ||
|
|
||
| diffpy.fourigui.src.diffpy.fourigui.fourigui module | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| .. automodule:: diffpy.fourigui.src.diffpy.fourigui.fourigui | ||
| :members: | ||
| :undoc-members: | ||
| :show-inheritance: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| :tocdepth: -1 | ||
|
|
||
| diffpy.fourigui.src.diffpy package | ||
| ================================== | ||
|
|
||
| .. automodule:: diffpy.fourigui.src.diffpy | ||
| :members: | ||
| :undoc-members: | ||
| :show-inheritance: | ||
|
|
||
| Subpackages | ||
| ----------- | ||
|
|
||
| .. toctree:: | ||
| :titlesonly: | ||
|
|
||
| diffpy.fourigui.src.diffpy.fourigui |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| :tocdepth: -1 | ||
|
|
||
| diffpy.fourigui.src package | ||
| =========================== | ||
|
|
||
| .. automodule:: diffpy.fourigui.src | ||
| :members: | ||
| :undoc-members: | ||
| :show-inheritance: | ||
|
|
||
| Subpackages | ||
| ----------- | ||
|
|
||
| .. toctree:: | ||
| :titlesonly: | ||
|
|
||
| diffpy.fourigui.src.diffpy | ||
| diffpy.fourigui.src.diffpy.fourigui.egg-info |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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/fouriguias just.. Will create a new PR