Documentation using mkdocs #287
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Added mkdocs dependencies. - Added mkdocs.yml file. - Moved example notebooks and script readme files to docs. - Included code for custom homepage.
- mkdocs-material now natively supports creation date.
- Mostly making commit in order develop on another machine.
- Also some PEP8 fixes.
- PEP8 fixes.
- Minor fixes in other files. - Added gen_doc_stubs.py to be tracked.
- Also in source.py, _make_png() -> make_png(), as make_png() held all the code for creating the plot I thought it shouldn't be hidden.
- Tidied some other files docstrings.
* Completed Introduction, Installation and Configuration pages. * Moved example notebooks back to main directory and created symlink from docs directory.
- Also some docstring improvements to `moc.py`.
- Pipeline doc page completed. - Images added to support pipeline doc page. - Edits to pipeline.py docstrings. - Pipeline diagnostic plot df argument changed to optional. - Color scheme change on homepage. - Minor edits to mocs.md.
- Completed the query component doc page. - Minor edits to pipeline.md. - Added RACS note to configuration page. - Activated other notebook examples. - Added missing docstring for `search_around_coordinates` in query.py. - Added pluto to ALLOWED_PLANETS.
- Completed Survey component doc page. - Commented out survey.Fields methods (not used). - Removed pluto from allowed planets. - Minor edits and improvements to other pages. - Added info on forced fit outputs.
- Changelog, code of conduct, license and help pages. - Notebook overview page. - Contributing pages. - Moved notebook examples to softlink to the individual files rather than the directory.
- Updated changelog - Added homepage image - Updated notebook examples - Minor edits - Added docs workflow
- Made sure m metrics were absolute value. - Fixed min_snr to max_snr in pipeline notebook. - Updated dependancies to fix search bar glitch in notebook doc pages. - Added edit url to mkdocs.yml.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A reissue of PR #273 to avoid squashing the commits.