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

Refactor documentation #127

Merged
merged 9 commits into from
Oct 12, 2023
Merged

Refactor documentation #127

merged 9 commits into from
Oct 12, 2023

Conversation

gnikit
Copy link
Member

@gnikit gnikit commented Sep 13, 2023

Fixes #126 (see issue for changes)

Changes

See #126

Minor Changes

  • Define myst_heading_anchors = 5 to generate implicit anchors (previously not generated in Manifest), resolves warnings.
  • Fixes {code-block} sh definitions, resolves warnings.

TODO

  • Section cross-references

@gnikit
Copy link
Member Author

gnikit commented Sep 15, 2023

#preview

@gnikit gnikit marked this pull request as ready for review September 19, 2023 18:46
@gnikit
Copy link
Member Author

gnikit commented Sep 19, 2023

I pinged you all because of the rewrite of the Registry section which completely removes the old registry and places the options for the new one. Let me know if you think we should preserve the old registry, in our docs.

@gnikit
Copy link
Member Author

gnikit commented Oct 3, 2023

ping @fortran-lang/admins, could you guys have a quick look and let me know if we should include/change something in the new docs? The folks over at OpenMP are finishing their blog post about fpm and it would be good if our docs were updated before that.

Copy link
Member

@milancurcic milancurcic left a comment

Choose a reason for hiding this comment

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

I haven't tested locally but the description of changes look good to me. Thank you for this work.

Adds example for calculating PI using OpenMP and fpm
@gnikit
Copy link
Member Author

gnikit commented Oct 12, 2023

I haven't tested locally but the description of changes look good to me. Thank you for this work.

Thanks, due to bug #129 our main docs have gotten already deployed from this branch. So if you look at the webpage now, you will be able to see the rendered website.

@gnikit gnikit merged commit b1b73bf into main Oct 12, 2023
8 checks passed
@gnikit gnikit deleted the docs/refactor branch October 12, 2023 13:38
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.

Restructuring of the fpm docs
3 participants