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.

Sign up for GitHub

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

Jump to bottom

docs: Refactor docs directory hierarchy #18773

Merged
merged 4 commits into from
Sep 20, 2024
Merged

docs: Refactor docs directory hierarchy #18773

merged 4 commits into from
Sep 20, 2024

Conversation

rodrigogiraoserrao
Copy link
Contributor

@rodrigogiraoserrao rodrigogiraoserrao commented Sep 16, 2024 •
edited
Loading

Split docs folder into two subfolders.

All the main documentation content lives in docs/source.
Dynamically generated content lives in docs/assets.
This split prevents the MkDocs live reloading from entering an infinite loop when generating data files, images, or pages, for the documentation while it's being served with mkdocs serve.

@github-actions github-actions bot added documentation Improvements or additions to documentation python Related to Python Polars rust Related to Rust Polars labels Sep 16, 2024
@rodrigogiraoserrao rodrigogiraoserrao marked this pull request as ready for review September 16, 2024 14:30
@rodrigogiraoserrao
Copy link
Contributor Author

rodrigogiraoserrao commented Sep 16, 2024 •
edited
Loading

I'm not necessarily a huge fan of the names docs/docs and docs/docs-res but nothing better came to mind.
I'm open to other suggestions.

EDIT: this has been solved with the help of orlp.

@orlp
Copy link
Collaborator

orlp commented Sep 16, 2024

Does this PR affect the generated paths of the output (breaking existing links), or only the organization in the source tree?

As for naming suggestions, may I suggest docs/text and docs/assets?

@rodrigogiraoserrao
Copy link
Contributor Author

Does this PR affect the generated paths of the output (breaking existing links), or only the organization in the source tree?

I don't understand the question.
Things have been moved around but the internal paths / links have been updated so everything still knows where everything is.

As for naming suggestions, may I suggest docs/text and docs/assets?

I like docs/assets; I don't love docs/text because I have things like the _build and src directories that contain scripts, snippets of code, and other assorted stuff.

@codecov Codecov
Copy link

codecov bot commented Sep 16, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.85%. Comparing base (b7e5e09) to head (6a2b4bc).
Report is 4 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main   #18773   +/-   ##
=======================================
  Coverage   79.85%   79.85%           
=======================================
  Files        1518     1518           
  Lines      205637   205637           
  Branches     2893     2893           
=======================================
  Hits       164205   164205           
  Misses      40884    40884           
  Partials      548      548

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@orlp
Copy link
Collaborator

orlp commented Sep 18, 2024

@rodrigogiraoserrao docs/source and docs/assets is fine by me.

@rodrigogiraoserrao
docs: Refactor docs directory hierarchy
cd12eec 
Split docs folder into two subfolders.
All the main docs content lives in `docs/docs`.
Dynamically generated content lives in `docs/docs-res`.
This split prevents the MkDocs live reloading from entering an infinite loop
when generating data files, images, or pages, for the documentation.
@rodrigogiraoserrao
docs: Fix external links and formatting
36d7a62
@rodrigogiraoserrao
Copy link
Contributor Author

The link analyser is complaining about a link that is indeed working... 🤷

@ritchie46 ritchie46 merged commit 2b4986a into pola-rs:main Sep 20, 2024
28 of 29 checks passed
@rodrigogiraoserrao rodrigogiraoserrao deleted the split-docs-hierarchy branch September 21, 2024 12:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ritchie46 ritchie46 Awaiting requested review from ritchie46 ritchie46 is a code owner

@orlp orlp Awaiting requested review from orlp orlp is a code owner

@c-peters c-peters Awaiting requested review from c-peters c-peters is a code owner

@alexander-beedie alexander-beedie Awaiting requested review from alexander-beedie alexander-beedie is a code owner

@MarcoGorelli MarcoGorelli Awaiting requested review from MarcoGorelli MarcoGorelli is a code owner

@reswqa reswqa Awaiting requested review from reswqa reswqa is a code owner

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation python Related to Python Polars rust Related to Rust Polars
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@rodrigogiraoserrao @orlp @ritchie46