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

Migrating from sphinx to Material for MkDocs #715

Merged
merged 60 commits into from
Jul 22, 2024

Conversation

DeaMariaLeon
Copy link
Collaborator

@DeaMariaLeon DeaMariaLeon commented Jul 5, 2024

This is a work in progress in case you want to see locally what I have done.
As you know, if you download my branch, one can see the docs locally running mkdocs serve.

Please note that these points are still pending before starting the next step of adding more documentation.

  • Cross-reference links.

  • The rest of the main rst pages like install, construct, etc, are still missing. But need links fixed

  • Some format on the API documents need to be fixed as well. Like the area of the examples.

  • Headers, logo, footers need to be added.

  • Website needs to be deployed with mkdocs instead of Sphinx

@hameerabbasi @mtsokol

mkdocs.yml Outdated Show resolved Hide resolved
@DeaMariaLeon DeaMariaLeon marked this pull request as ready for review July 18, 2024 16:59
Copy link
Collaborator

@hameerabbasi hameerabbasi left a comment

Choose a reason for hiding this comment

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

Some minor changes, but LGTM overall. Thanks for all the hard work, @DeaMariaLeon!

.readthedocs.yml Outdated Show resolved Hide resolved
docs/construct.md Outdated Show resolved Hide resolved
docs/construct.md Outdated Show resolved Hide resolved
docs/contributing.md Outdated Show resolved Hide resolved
@DeaMariaLeon DeaMariaLeon changed the title WIP: Migrating from sphinx to Material for MkDocs Migrating from sphinx to Material for MkDocs Jul 20, 2024
@DeaMariaLeon
Copy link
Collaborator Author

I think I addressed all the requested changes. Please let me know if something is missing.

Copy link
Collaborator

@hameerabbasi hameerabbasi left a comment

Choose a reason for hiding this comment

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

Some minor missed changes, then we're all good.

.readthedocs.yml Show resolved Hide resolved
docs/quickstart.md Outdated Show resolved Hide resolved
docs/quickstart.md Outdated Show resolved Hide resolved
docs/quickstart.md Outdated Show resolved Hide resolved
docs/quickstart.md Outdated Show resolved Hide resolved
docs/quickstart.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@hameerabbasi hameerabbasi left a comment

Choose a reason for hiding this comment

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

Thanks for this heavy lift and your patience, @DeaMariaLeon! Let's get this in and iterate on it at this point.

@hameerabbasi hameerabbasi enabled auto-merge (squash) July 22, 2024 06:39
@hameerabbasi hameerabbasi merged commit 549df96 into pydata:main Jul 22, 2024
15 of 16 checks passed
@DeaMariaLeon
Copy link
Collaborator Author

Thank you @hameerabbasi !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants