Skeleton architecture documentation #387
Merged
Conversation
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
Tries to explain a few concepts and expected outputs from papyri.
melissawm
commented
Feb 9, 2024
Comment on lines
+354
to
+361
| - A `papyri.json` file, which is a list of unique qualified names corresponding | ||
| to the documented objects and some metadata; | ||
| - A `toc.json` file, ? | ||
| - An `assets` folder, containing all the images generated during the | ||
| generation; | ||
| - A `docs` folder, ? | ||
| - An `examples` folder, ? | ||
| - A `module` folder, containing one json file per documented object. |
There was a problem hiding this comment.
Personally this is the kind of information I'd love to have, but not sure if it's too much detail.
| - An `examples` folder, ? | ||
| - A `module` folder, containing one json file per documented object. | ||
|
|
||
| After the generation step, *what should have been processed*? |
There was a problem hiding this comment.
This is the crucial step that will help new contributors, as it will probably point people to what hasn't been implemented yet
melissawm
commented
Feb 9, 2024
|
|
||
| ### Jupyter extension | ||
|
|
||
| In progress. |
There was a problem hiding this comment.
I couldn't immediately find how to run papyri as a jupyter extension
There was a problem hiding this comment.
There is a sub-readme, and yes it's complicated, I would need to publish it as its own subpackage.
Carreau
approved these changes
Feb 12, 2024
|
|
||
| ### Jupyter extension | ||
|
|
||
| In progress. |
There was a problem hiding this comment.
There is a sub-readme, and yes it's complicated, I would need to publish it as its own subpackage.
Comment on lines
+354
to
+361
| - A `papyri.json` file, which is a list of unique qualified names corresponding | ||
| to the documented objects and some metadata; | ||
| - A `toc.json` file, ? | ||
| - An `assets` folder, containing all the images generated during the | ||
| generation; | ||
| - A `docs` folder, ? | ||
| - An `examples` folder, ? | ||
| - A `module` folder, containing one json file per documented object. |
|
Let's get this in, we can refine once you are back from PTO |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Tries to explain a few concepts and expected outputs from papyri. There's a bunch of stuff to expand on but I thought this could be useful especially for new contributors.
There's nothing really new, just some reorganization and highlighting.