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 Fixes (ReadTheDocs) #35

Open
rmclaren opened this issue Nov 24, 2024 · 1 comment
Open

Documentation Fixes (ReadTheDocs) #35

rmclaren opened this issue Nov 24, 2024 · 1 comment

Comments

@rmclaren
Copy link
Collaborator

There are some mistakes in the Read the Docs documentation files that need to be fixed.

The YAML example is not quiet correct. (Compare with actual test YAML files).

I believe some of the Python examples may have problems, again compare with relevant test files and make sure they are consistent.

Add installation section.

Generally improvements needed...

@rmclaren
Copy link
Collaborator Author

Fixed YAML file example in #38 .

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

No branches or pull requests

1 participant