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.

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

Documentation improvements #699

Merged
merged 83 commits into from
Sep 24, 2024
Merged

Documentation improvements #699

merged 83 commits into from
Sep 24, 2024

Conversation

dkfellows
Copy link
Collaborator

@dkfellows dkfellows commented Jul 23, 2024

Working on improving documentation.

  • CI building of docs (or at least the Sphinx part)
  • Fix errors in doc build
  • Add missing method docs

There's still some places where things are double-linked. Those are quite tricky to hunt down when they're in the output of autodoc.

@dkfellows
Copy link
Collaborator Author

That's all the remaining faults that I can fix. The ones that are left (all warnings) are due to the combination of importing the cli stuff from hpcflow.sdk into hpcflow.app and the CLI documentation being generated by click; the place where it's going wrong is just too deep within the nest of generated stuff.

@dkfellows dkfellows added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 4, 2024
@dkfellows dkfellows mentioned this pull request Sep 4, 2024
3 tasks
Copy link
Contributor

@aplowman aplowman left a comment

Choose a reason for hiding this comment

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

Excellent, thanks!

@dkfellows dkfellows requested a review from aplowman September 24, 2024 13:07
@dkfellows dkfellows merged commit 2e3ac46 into develop Sep 24, 2024
49 checks passed
@dkfellows dkfellows deleted the doc branch September 24, 2024 13:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants