Skip to content
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

Migrate API Guide from CHM to markdown #177

Open
michaeltryby opened this issue May 13, 2024 · 0 comments
Open

Migrate API Guide from CHM to markdown #177

michaeltryby opened this issue May 13, 2024 · 0 comments
Assignees
@michaeltryby
Labels
enhancement
Milestone
v5.3.0

Comments

@michaeltryby
Copy link
Collaborator

michaeltryby commented May 13, 2024 •
edited
Loading

The SWMM 5.2.4 API Guide describes SWMM's input file format, command line tool, and dll API. As such it is closely aligned with the solver code residing in this repository.

As part of the documentation modernization for the coming release, I propose migrating it from CHM to markdown and configuring Doxygen / Github to generate and host a static documentation website.

PR coming forthwith.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@michaeltryby michaeltryby

Labels
enhancement
Projects
None yet
Milestone
v5.3.0
Development

No branches or pull requests
1 participant
@michaeltryby