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

Code reference documentation update #480

Merged
merged 7 commits into from
Apr 1, 2021

Conversation

ajstewart
Copy link
Contributor

@ajstewart ajstewart commented Mar 26, 2021

Added a code reference section to the documentation

  • New docs dependency of mkdocs-gen-files.
  • Auto generates pages using mkdocs-gen-files.
  • Updated non-google format docstrings to google format.

Note that this is based on #471.

- New docs dependency of `mkdocs-gen-files`.
- Auto generates pages using `mkdocs-gen-files`.
- Updated non-google format docstrings to google format.
@github-actions github-actions bot added this to In progress in Pipeline Backlog Mar 26, 2021
@ajstewart ajstewart changed the title Added a code reference section to the documentation Code reference documentation update Mar 26, 2021
@ajstewart
Copy link
Contributor Author

ajstewart commented Mar 26, 2021

@marxide @srggrs (cc @dliptai) I've gone through and activated the code reference using mkdocstrings, so we have begin to have some code referencing in the documentation. Most of the work involved updating all the docstrings to the google format and I've also filled in a lot of empty docstrings.

Again it's probably much easier to serve the docs and look at them directly.

I know there is some majorish work going on with some of the functions which will make the docstrings obsolete but maybe this seeing as this is really only changing the docstrings I'm hoping it will be quite smooth to maybe merge this first and then rebase other branches?

Some notes:

  • This is based on my other branch in Documentation update #471 - to avoid that one getting huge.
  • I've activated it only on the vast_pipeline directory.
  • views.py and serializers.py are problematic (see the comment in the code).
  • I have left out the migrations and tests sub-directories.
    • I left out tests simply because there is a lot in there and I wasn't sure I had the time. But it should be updated and gone through by someone.
  • I'm using mkdocs-gen-files to automatically generate the markdown files, this is done in the script docs/gen_doc_stubs.py, which is also where I define which files and directories to skip.
  • I follow the PEP 484 type annotations format in the google docstrings.
  • I'm unsure on the debug function in auth.py there is a TODO here.
  • The main module comments at the top may be inconsistent - i.e. I might have missed some, please feel free to just add these in if you see one.

@ajstewart ajstewart added cleanup Clean up code documentation Improvements or additions to documentation labels Mar 26, 2021
@ajstewart ajstewart marked this pull request as ready for review March 26, 2021 19:31
@ajstewart ajstewart self-assigned this Mar 26, 2021
@ajstewart ajstewart mentioned this pull request Mar 30, 2021
Pipeline Backlog automation moved this from In progress to Reviewer approved Mar 31, 2021
@ajstewart ajstewart merged commit ede5a73 into docs-update-adam Apr 1, 2021
@ajstewart ajstewart deleted the docs-update-code-reference branch April 1, 2021 18:31
Pipeline Backlog automation moved this from Reviewer approved to Done Apr 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cleanup Clean up code documentation Improvements or additions to documentation
Projects
Development

Successfully merging this pull request may close these issues.

None yet

2 participants