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

Better Package Style layout #71

Merged
merged 37 commits into from
Apr 5, 2022
Merged

Better Package Style layout #71

merged 37 commits into from
Apr 5, 2022

Conversation

jorgepiloto
Copy link
Member

Resolves #62 and partially addresses #64.

@akaszynski
Copy link
Contributor

This is way better already. Agree that we don't need a separate page per topic.

@jorgepiloto jorgepiloto force-pushed the feat/packaing_style branch from f5a6fc3 to 5e1d2c4 Compare March 29, 2022 10:21
@jorgepiloto
Copy link
Member Author

jorgepiloto commented Mar 29, 2022

I decide to add Graphviz diagrams. These turned out to be really useful and more informative than the tree-based ones. In addition, taking advantage of the .. include:: directive, it is possible to store these diagrams in a common directory.

Notice these diagrams follow RST syntax and are rendered when executing Sphinx.

@akaszynski
Copy link
Contributor

I decide to add Graphviz diagrams.

This is great and maintainable!

@jorgepiloto
Copy link
Member Author

Graphviz is a little bit tricky when it comes to linking subgraphs. Nevertheless, I managed to solve this locally. The build-system diagram is going to look really cool! 🚀

@jorgepiloto
Copy link
Member Author

Adding here some useful references:

@akaszynski
Copy link
Contributor

Adding here some useful references:

About to add "api docs" and I'll need this.

jorgepiloto and others added 2 commits April 1, 2022 08:16
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
@PipKat
Copy link
Member

PipKat commented Apr 4, 2022

@jorgepiloto @akaszynski
I have completed my editorial review.

Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
Comment on lines +3 to +4
:caption: A Python library is a collection of packages.
:alt: A Python library is a collection of packages.
Copy link
Member Author

@jorgepiloto jorgepiloto Apr 4, 2022

Choose a reason for hiding this comment

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

I think figure captions need to end with a period. Will modify the rest accordingly.

Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
@jorgepiloto
Copy link
Member Author

Thanks for such a deep review @PipKat! I applied all the suggested changes 👍🏽

@jorgepiloto
Copy link
Member Author

Finally, merging this 🚀

@jorgepiloto jorgepiloto merged commit 9023620 into main Apr 5, 2022
@jorgepiloto jorgepiloto deleted the feat/packaing_style branch April 5, 2022 07:45
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.

New Packaging Style guide
3 participants