Skip to content

import static documentation from old gh-pages site; refresh some content#35

Merged
edbennett merged 2 commits into
developfrom
static-gh-pages
Apr 8, 2026
Merged

import static documentation from old gh-pages site; refresh some content#35
edbennett merged 2 commits into
developfrom
static-gh-pages

Conversation

@edbennett

@edbennett edbennett commented Mar 31, 2026

Copy link
Copy Markdown

To test:

  • Create a Python environment with pymdown-extensions, mkdocs, and mkdocs-literate-nav
  • Build the documentation: python -m mkdocs build
  • Serve the site on a local HTTP server: cd site && python -m http.server 8003
  • Go to http://localhost:8003 in your browser

@edbennett edbennett requested a review from gray95 March 31, 2026 16:14

@gray95 gray95 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Tested according to the instructions and everything works fine. Cursory glance at the generated docs - nothing glaring jumped out at me. mkdocs emits one warning, I don't know if it means anything.

$ python -m mkdocs build
INFO    -  Cleaning site directory
INFO    -  Building documentation to directory: /home/gsr/work/sa2c/Grid/site
WARNING -  Doc file 'api-description/introduction.md' contains an unrecognized relative link '../../dev', it was
           left as is. Did you mean '../dev/index.md'?
INFO    -  Documentation built in 0.13 seconds

@edbennett

Copy link
Copy Markdown
Author

Yes, that warning is expected, due to the way that the Doxygen content is included. Thanks!

@edbennett edbennett merged commit 5e11960 into develop Apr 8, 2026
2 checks passed
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.

2 participants