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

[sphinx docs] Formatting improvements #624

Closed
johny-b opened this issue Sep 1, 2021 · 0 comments
Closed

[sphinx docs] Formatting improvements #624

johny-b opened this issue Sep 1, 2021 · 0 comments
Assignees

Comments

@johny-b
Copy link
Contributor

johny-b commented Sep 1, 2021

This should be done after #623 .

Make the docs as pretty as possible (without influencing the merit of the docs).

This includes:

  • better formatting
  • adding "small" missing parts (e.g. some functions might be missing params or return sections, or more likely have them written in a non-formal way)
  • moving some parts of the docstrings (e.g. from Golem docstring) to the main docs file
  • internal restructuring (e.g. splitting the docs into more than one file)

DETAILS (as of aff21b1):

  1. Duplicated external links in menu
    -> done in ee649c0
  2. Golem.execute_tasks is rendered as async - why? Probably a bug in sphinx, removing yield helped. Maybe report a bug? Or maybe there's a way to fix this?
    -> I couldn't fix this, I guess this is a bug in sphinx. I created an issue: autodoc: Asynchronous Generators are marked as non-async functions sphinx-doc/sphinx#9639
  3. Find all functions in docs without specified params & fix them
  4. Read carefully once again
@johny-b johny-b self-assigned this Sep 14, 2021
@johny-b johny-b closed this as completed Oct 1, 2021
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