Skip to content

Format documentation#47

Merged
lunamorrow merged 17 commits intomainfrom
format-docs
Jan 22, 2025
Merged

Format documentation#47
lunamorrow merged 17 commits intomainfrom
format-docs

Conversation

@lunamorrow
Copy link
Contributor

@lunamorrow lunamorrow commented Jan 20, 2025

Checklist for formatting documentation and final repository checks before the PolyConstruct paper is published:

  • Convert PolyTop and PolyConf to toctree displays with separate pages for each module
  • Setup PolyBuild with single page for both scripts
  • Change Sphinx theme to custom theme with blue colour scheme
  • Add examples for PolyTop and PolyConf usage to respective packages
  • Add setup contents of repo README.md to the 'Getting Started' page
  • Add a logo representative of PolyConstruct
  • Ensure all PolyTop tests are still running as expected (currently breaking due to changes in import paths ahh!)

…d each module within it has a seperate page easily navigated to and in between. PolyBuild is an exception, as it only has 2 scripts, so is contained in a single page for readability
@lunamorrow lunamorrow linked an issue Jan 22, 2025 that may be closed by this pull request
@lunamorrow lunamorrow merged commit 64043af into main Jan 22, 2025
1 check passed
@lunamorrow lunamorrow deleted the format-docs branch January 28, 2025 03:34
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.

Make documentation separate classes/modules onto seperate pages

1 participant