Skip to content

Set up documentation building from docstrings#33

Merged
fnesveda merged 4 commits intomasterfrom
feature/docs-building
Feb 26, 2021
Merged

Set up documentation building from docstrings#33
fnesveda merged 4 commits intomasterfrom
feature/docs-building

Conversation

@fnesveda
Copy link
Copy Markdown
Member

This PR introduces docs building from docstrings in code:

  • sets up docs building using Sphinx & a loooot of postprocessing
  • fixes the docstring formatting for a lot of docstrings so they would render properly
  • adds __init__.py for all the subfolders with the right exports (necessary for Sphinx to work properly)
  • adds required packages for the docs building

I've also attached some other small changes & fixes:

  • updates outdated packages
  • adds a default me user ID to the UserClient, representing the user belonging to the token

@fnesveda fnesveda added this to the 7th sprint - Web & API team milestone Feb 22, 2021
@fnesveda fnesveda requested review from Equidem and mhamas February 22, 2021 16:15
@fnesveda fnesveda self-assigned this Feb 22, 2021
Copy link
Copy Markdown
Contributor

@mhamas mhamas left a comment

Choose a reason for hiding this comment

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

Wow, this is huge. Thx Franta, looks good!

Copy link
Copy Markdown
Contributor

@Equidem Equidem left a comment

Choose a reason for hiding this comment

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

Great work, just as @mhamas, I just have a few nitpicks.

@fnesveda
Copy link
Copy Markdown
Member Author

Thanks, guys! I've taken the texts from the JS clients, but I agree they're not 100% ideal, I incorporated the suggestions.

@fnesveda fnesveda merged commit ff2cc56 into master Feb 26, 2021
@fnesveda fnesveda deleted the feature/docs-building branch February 26, 2021 15:05
@fnesveda fnesveda added the validated Issues that are resolved and their solutions fulfill the acceptance criteria. label May 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

validated Issues that are resolved and their solutions fulfill the acceptance criteria.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants