Skip to content

Add generator documentation#248

Open
michaellans wants to merge 4 commits intoxopt-org:mainfrom
michaellans:update_docs2
Open

Add generator documentation#248
michaellans wants to merge 4 commits intoxopt-org:mainfrom
michaellans:update_docs2

Conversation

@michaellans
Copy link
Contributor

  • Adds generators directory within documentation/docs/guides/ with .md files giving individual algorithm overviews and xopt generator parameters. These files are also used for building generator docs via the BadgerDocsWindow within the GUI
  • updated factory.get_generator_docs() to combine Badger documentation .md file with xopt generator docstring, similar to the environment docs
  • Fixed typo in help_md string construction to only show the docstring as a code block and render the rest as markdown

@michaellans michaellans marked this pull request as draft February 9, 2026 19:50
@michaellans michaellans marked this pull request as ready for review February 10, 2026 00:08
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.

1 participant