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

docs: add Read the Docs config file #186

Merged
merged 2 commits into from
Dec 2, 2023
Merged

Conversation

alohamora
Copy link
Contributor

@alohamora alohamora commented Dec 2, 2023

Description

  • Add Read the Docs config (v2) recently made mandatory
  • Provide specific requirements for API doc generation

Fixes #165

Type of change

  • Documentation update

Co-authored-by: Aditya Arora <aditya.arora@ambient.ai>
@uniqueg
Copy link
Member

uniqueg commented Dec 2, 2023

@alohamora: Tests fail, presumably because of #182. If tests pass now that I have merged #185, you can go ahead and merge this one

Copy link

codecov bot commented Dec 2, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (d4c1280) 100.00% compared to head (7f4bee1) 100.00%.

Additional details and impacted files
@@            Coverage Diff            @@
##               dev      #186   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           20        20           
  Lines          978       978           
=========================================
  Hits           978       978           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@uniqueg uniqueg merged commit 80f0136 into dev Dec 2, 2023
14 checks passed
@uniqueg uniqueg deleted the docs/add-readthedocs-config branch December 2, 2023 14:42
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

Successfully merging this pull request may close these issues.

Fix API docs
3 participants