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

Add PhaseFieldX to Sphinx projects list #12830

Merged
merged 5 commits into from
Sep 18, 2024

Conversation

CastillonMiguel
Copy link
Contributor

Subject: Add PhaseFieldX to Sphinx projects list

Purpose

  • Add the new project “PhaseFieldX” to the list of available projects in Sphinx documentation.

@jayaddison
Copy link
Contributor

Hi @CastillonMiguel - thank you for your pull request. Could I ask what the purpose of adding your documentation to the Sphinx listed projects is?

Please note: there's a syntax problem in your index.rst file - possibly some use of Markdown instead of RST in the contributions/feedback paragraph: https://github.com/CastillonMiguel/phasefieldx/blob/14d39f275acdccbec42d0c937d7cdcfb519d54e0/docs/source/index.rst?plain=1#L34

@jayaddison jayaddison added type:docs awaiting:response Waiting for a response from the author of this issue labels Sep 3, 2024
@CastillonMiguel
Copy link
Contributor Author

Hi @jayaddison. Thanks for reviewing my pull request and pointing out the syntax issue in the index.rst file—I’ve corrected it.

I added the documentation to the Sphinx listed projects to increase visibility for the open-source PhaseFieldX project and to provide a structured example that others might find useful for their projects.

@jayaddison jayaddison removed the awaiting:response Waiting for a response from the author of this issue label Sep 9, 2024
EXAMPLES.rst Outdated Show resolved Hide resolved
@AA-Turner AA-Turner merged commit 61426f4 into sphinx-doc:master Sep 18, 2024
6 of 7 checks passed
@CastillonMiguel CastillonMiguel deleted the patch-1 branch September 18, 2024 07:18
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.

3 participants