Skip to content

Compile sipnet docs to gh-pages #41

@dlebauer

Description

@dlebauer

Description:

  • compile all docs (md + doxygen) into a single website
  • create GitHub action to publish these to gh-pages when changes are merged into master branch
  • optional - add make document-website (?)

In the short term, start with what we have (README, CONTRIBUTING, Doxygen, CODE_OF_CONDUCT, CHANGELOG from #33)

In the end, the documentation structure could be:

├── Home (README)
├── User Guide
│   ├── Running SIPNET
│   ├── Model Structure
│   └── Parameters and Configuration
├── Developer Guide
│   ├── Code structure
│   └── Contributing (Contributing.md)
│     └── additional details beyond scope of Contributing.md
├── API Reference (generated from Doxygen)
└── Changelog (if just a matter of adding another md file)
└── Code of Conduct

Approach

As far as frameworks, it looks like MkDocs is simple and lightweight which is consistent with the SIPNET approach. I also considered Docusaurus since it is used for the website (https://github.com/pecanproject/pecanproject.github.io), but I don't think the additional overhead is warranted for a straightforward documentation site. Both will combine md and doxygen html.

Not required, but consider whether MkDoxy will simplify Doxygen integration.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions