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

docs: add style guide, tidy dev/contrib docs, update docs sites #1870

Merged
merged 4 commits into from
Jun 20, 2024

Conversation

wpbonelli
Copy link
Contributor

@wpbonelli wpbonelli commented Jun 12, 2024

  • add styleguide section and guidelines/conventions to RTD site
    • transcribed from Feb. 2024 developer meeting
    • added very minimal sample module, maybe others can extend?
  • clean up DEVELOPER.md and CONTRIBUTING.md
    • describe fprettify and check_format.py usage
    • update outdated parts of contributing guide
    • update outdated TOCs
    • don't detail git commands, contributors can discover these elsewhere
  • remove update_fortran_style.py
    • plan to move related efforts to fprettify eventually
    • existing code can be updated manually/opportunistically for now
  • minor improvements/cleanup to docs sites
    • rename RTD site "MODFLOW 6 Program Documentation" -> "MODFLOW 6"
    • rename api ref site "Source Code Documentation" -> "API Reference"
    • update api ref site brief to "USGS Modular Hydrologic Model"
    • update section names in TOCs
    • bump copyright date years
    • minor explication

@wpbonelli wpbonelli added documentation Documentation changes help wanted Contributions welcome! maintenance Sprucing up the code labels Jun 12, 2024
@langevin-usgs
Copy link
Contributor

We're off the ground!

wpbonelli and others added 2 commits June 18, 2024 10:05
* move styleguide to rtd
* cleanup docs site names/descriptions/tocs
* cleanup contributor and developer docs
* move fprettify usage demo from contrib to dev docs
@wpbonelli wpbonelli changed the title docs(CONTRIBUTING): add fortran style guide, describe formatting scripts docs: add style guide, tidy dev/contrib docs, update docs sites Jun 18, 2024
@wpbonelli wpbonelli marked this pull request as ready for review June 18, 2024 19:28
@wpbonelli
Copy link
Contributor Author

I will plan to merge when the Canonical outage is resolved after discussing with @Manangka who has platform-specific fixes and more to come in a subsequent PR — also may make feedback easier to have an initial render up on RTD

@wpbonelli wpbonelli merged commit e8d2c60 into MODFLOW-USGS:develop Jun 20, 2024
21 checks passed
@wpbonelli wpbonelli deleted the styleguide branch June 20, 2024 22:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation changes help wanted Contributions welcome! maintenance Sprucing up the code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants