Adding docs config and requirements #65
Conversation
tox.ini
Outdated
| @@ -57,6 +57,7 @@ commands = | |||
| [testenv:docs] | |||
| deps = | |||
| -c dev-requirements.txt | |||
There was a problem hiding this comment.
Do we still need dev-requirements.txt in the doc env?
There was a problem hiding this comment.
Yes, at least pytest is needed
There was a problem hiding this comment.
Never mind looks like there is some duplication of packages in requirement files, will clean up a little bit
docs-requirements.txt
Outdated
| # External | ||
| opentelemetry-api | ||
| opentelemetry-sdk | ||
| psutil |
There was a problem hiding this comment.
I get errors if I don't include psutil but I can't seem to find where in the docs it is needed.
There was a problem hiding this comment.
psutil is used in PerformanceMetrics class, docs need all external libraries used in the code to be able to build
Codecov Report
@@ Coverage Diff @@
## master #65 +/- ##
=======================================
Coverage 98.67% 98.67%
=======================================
Files 14 14
Lines 753 753
Branches 97 97
=======================================
Hits 743 743
Misses 8 8
Partials 2 2 Continue to review full report at Codecov.
|
Local docs deployed available here:
https://hectorhdzg-opentelemetry-azure-python.readthedocs.io/en/latest/index.html