Skip to content

User guide docs #62

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 56 commits into from
Jun 30, 2025
Merged

User guide docs #62

merged 56 commits into from
Jun 30, 2025

Conversation

tdrwenski
Copy link
Collaborator

@tdrwenski tdrwenski commented Jun 13, 2025 •
edited
Loading

  • Use mkdocs to build user guid documentation and deploy with a GitHub workflow. Currently is deployed to https://software.llnl.gov/quandary/
  • Starting from user_guide.tex, adapt user guide to markdown format. Equations can still be in latex, but refs, citations, enumerations, items, bold/italics, section headings, etc are slightly different for markdown format.
  • Link to doxygen docs
  • Break up into multiple sections
    • Update README to link to docs
  • TODO: remove deploy on this branch

tdrwenski added 30 commits June 13, 2025 16:25
@tdrwenski
Add mkdocs config and github workflow to deploy mkdocs
82a96fc
@tdrwenski
Start from latex document
55eb325
@tdrwenski
Remove latex new package and commands and start/end doc
83b6fbf
@tdrwenski
Convert sections and subsections to md
4849861
@tdrwenski
Fix itemize, enumerate, bold, italic formatting for md
5d16aec
@tdrwenski
Add whitespace around equations
e520605
@tdrwenski
Whitespace cleanups, avoid indentation
dbe9f6e
@tdrwenski
Fix title and authors
b7ba9d9
@tdrwenski
Fix itemize list
b6c79ac
@tdrwenski
Fix itemize
d7fc0e1
@tdrwenski
Fix \textt for markdown
13e184d
@tdrwenski
Fix eqref
d52ee2d
@tdrwenski
Fix comments
ac72e49
@tdrwenski
Fix citations
36c97fc
@tdrwenski
Whitespace fixes
1d5b728
@tdrwenski
Fix latex tildes
9e03d10
@tdrwenski
Remove unneeded \appendix and \bib
7867083
@tdrwenski
Whitespace fixes
772e7aa
@tdrwenski
Add code snippet macro
25d4320
@tdrwenski
Whitespace fixes
7039718
@tdrwenski
Fix mathds R
c3e77d3
@tdrwenski
Fix section references
e33d89a
@tdrwenski
Add brackets around dot
43e3041
@tdrwenski
Rename userguide and move bibtex file
c436d2d
@tdrwenski
Fix verbatim blocks
aa5fe70
@tdrwenski
Use mathbb instead of mathds
cd1457f
@tdrwenski
WIP deploy docs on this branch
0f99b9a
@tdrwenski
Don't accidentally remove other gh-pages artifacts
31303aa
@tdrwenski
Link to doxygen on mkdocs
c43f9bc
@tdrwenski
Improve code block formating
ab7f1af
@tdrwenski tdrwenski changed the title WIP User guide docs User guide docs Jun 17, 2025
@steffi7574
Copy link
Member

Looks good from my end! Double-check the link to Doxygen please, I couldn't make it work. Thanks!

@tdrwenski
Copy link
Collaborator Author

Fixed the doxygen link!

I'm seeing these warnings:

INFO    -  Doc file 'user_guide.md' contains a link '#sec:ensemblestate', but there is no such anchor on this page.
INFO    -  Doc file 'user_guide.md' contains a link '#sec:essentiallevels', but there is no such anchor on this page.

@tdrwenski tdrwenski merged commit 1d4ee63 into main Jun 30, 2025
0 of 2 checks passed
@tdrwenski tdrwenski deleted the user-guide-docs branch June 30, 2025 20:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@steffi7574 steffi7574 steffi7574 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@tdrwenski @steffi7574