Prepare to host on readthedocs.org #452

c24t · 2020-02-28T22:39:57Z

Fixes #171

You can see the hosted docs built from this branch on https://opentelemetry-python.readthedocs.io/en/readthedocs/, and the successful build from 3e7a9e9 at https://readthedocs.org/projects/opentelemetry-python/builds/10524660/.

Note that the docs can still fail to build on RTD even if tox -e docs passes on CI. See https://readthedocs.org/projects/opentelemetry-python/builds/10524617/ for an example of a failing build that passed CI.

I'll delete the branch and build the docs from master (which should populate the "latest" and "stable" versions on RTD) once this PR is merged.

but don't actually restrict to specific versions of dev-only packages.

codecov-io · 2020-02-28T22:43:16Z

Codecov Report

Merging #452 into master will increase coverage by 0.47%.
The diff coverage is n/a.

@@            Coverage Diff            @@
##           master    #452      +/-   ##
=========================================
+ Coverage   89.23%   89.7%   +0.47%     
=========================================
  Files          41      43       +2     
  Lines        2090    2458     +368     
  Branches      237     301      +64     
=========================================
+ Hits         1865    2205     +340     
- Misses        156     177      +21     
- Partials       69      76       +7

Impacted Files	Coverage Δ
...elemetry-api/src/opentelemetry/metrics/__init__.py	`89.2% <0%> (-6.38%)`	⬇️
...etry-sdk/src/opentelemetry/sdk/metrics/__init__.py	`97.42% <0%> (-0.87%)`	⬇️
...entelemetry-api/src/opentelemetry/util/__init__.py	`83.33% <0%> (ø)`	⬆️
...lemetry-sdk/src/opentelemetry/sdk/util/__init__.py	`85.88% <0%> (ø)`
...-sdk/src/opentelemetry/sdk/util/instrumentation.py	`80.95% <0%> (ø)`
...emetry-sdk/src/opentelemetry/sdk/trace/__init__.py	`94.73% <0%> (+3.56%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c2ba065...77902af. Read the comment docs.

hectorhdzg

Nice!

mauriciovasquezbernal · 2020-03-02T15:52:21Z

Nice, this will allow us to improve documentation a lot!

Do you have any idea why the documentation for some of the ext packages is not being generated?

For instance, the Jaeger exporter is almost empty:

But, when I compiled locally with cd docs && make html I get:

codeboten

This is looking good, thanks for taking this on. Should the link in the README be updated to point to readthedocs?

c24t · 2020-03-02T19:15:41Z

But, when I compiled locally with cd docs && make html I get:

Good call @mauriciovasquezbernal, I left out the ext requirements. It looks like if we use types from other packages in public type annotations those packages need to be installed when we generate the docs.

Fixed in 77902af, we now have docs for e.g. jaeger: https://opentelemetry-python.readthedocs.io/en/readthedocs/opentelemetry.ext.jaeger.html.

c24t · 2020-03-02T19:16:34Z

Should the link in the README be updated to point to readthedocs?

I think that's a good idea once we build the docs for master, right now we're building for this branch only. I'll update the README once this is merged.

Rename TracerSource to TracerProvider (open-telemetry#441) Following discussion in open-telemetry#434, align the name with the specification. Co-authored-by: Chris Kleinknecht <libc@google.com> Fix new ext READMEs (open-telemetry#444) Some of the new ext packages had ReStructuredText errors. PyPI rejected the uploads for these packages with: HTTPError: 400 Client Error: The description failed to render for 'text/x-rst'. See https://pypi.org/help/#description-content-type for more information. for url: https://upload.pypi.org/legacy/ Adding attach/detach methods as per spec (open-telemetry#429) This change updates the Context API with the following: - removes the remove_value method - removes the set_current method - adds attach and detach methods Fixes open-telemetry#420 Co-authored-by: Chris Kleinknecht <libc@google.com> Make Counter and MinMaxSumCount aggregators thread safe (open-telemetry#439) OT Collector trace exporter (open-telemetry#405) Based on the OpenCensus agent exporter. Fixes open-telemetry#343 Co-authored-by: Chris Kleinknecht <libc@google.com> API: Renaming TraceOptions to TraceFlags (open-telemetry#450) Renaming TraceOptions to TraceFlags, which is the term used to describe the flags associated with the trace in the OpenTelemetry specification. Closes open-telemetry#434 api: Implement "named" meters + Remove "Batcher" from Meter constructor (open-telemetry#431) Implements open-telemetry#221. Also fixes open-telemetry#394. Stateful.py and stateless.py in metrics example folder are not changed to use the new loader in anticipation of open-telemetry#422 being merged first and removing them. Lastly, moves InstrumentationInfo from trace.py in the sdk to utils. Prepare to host on readthedocs.org (open-telemetry#452) sdk: Implement observer instrument (open-telemetry#425) Observer instruments are used to capture a current set of values at a point in time [1]. This commit extends the Meter interface to allow to register an observer instrument by pasing a callback that will be executed at collection time. The logic inside collection is updated to consider these instruments and a new ObserverAggregator is implemented. [1] https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/api-metrics.md#observer-instruments sdk: fix ConsoleSpanExporter (open-telemetry#455) 19d573a ("Add io and formatter options to console exporter (open-telemetry#412)") changed the way spans are printed by using write() instead of print(). In Python 3.x sys.stdout is line-buffered, so the spans were not being printed to the console at the right timing. This commit fixes that by adding an explicit flush() call at the end of the export function , it also changes the default formatter to include a line break. To be precise, only one of the changes was needed to solve the problem, but as a matter of completness both are included, i.e, to handle the case where the formatter chosen by the user doesn't append a line break. jaeger: Usage README Update for opentelemetry-ext-jaeger (open-telemetry#459) Usage docs for opentelemetry-ext-jaeger need to be updated after the change to `TracerSource` with v0.4. Looks like it was partially updated already. Users following the usage docs will currently run into this error: `AttributeError: 'Tracer' object has no attribute 'add_span_processor'` api: Implementing Propagators API to use Context (open-telemetry#446) Implementing Propagators API to use Context. Moving tracecontexthttptextformat to trace/propagation, as TraceContext is specific to trace rather that broader context propagation. Using attach/detach for wsgi and flask extensions, enabling activation of the full context rather that activating of a sub component such as traces. Adding a composite propagator. Co-authored-by: Mauricio Vásquez <mauricio@kinvolk.io>

c24t added 6 commits February 28, 2020 13:57

Add .readthedocs.yml

16ec59a

Split out docs requirements

6ccd47f

Remove docs requirements versions

7c24fd8

Use explicit deps with constraints in tox

31a8f41

but don't actually restrict to specific versions of dev-only packages.

Stick to known good sphinx and etc. versions

4af9826

Bump sphinx version

3e7a9e9

c24t requested a review from a team February 28, 2020 22:39

c24t mentioned this pull request Feb 28, 2020

Use latest sphinx packages to build docs #453

Closed

hectorhdzg approved these changes Feb 28, 2020

View reviewed changes

codeboten approved these changes Mar 2, 2020

View reviewed changes

Add ext docs requirements

77902af

c24t merged commit 344d72b into master Mar 2, 2020

c24t deleted the readthedocs branch March 2, 2020 19:42

c24t mentioned this pull request Mar 2, 2020

Consider including docs for each released version on GH pages #457

Closed

c24t added a commit to c24t/opentelemetry-python that referenced this pull request Mar 2, 2020

Prepare to host on readthedocs.org (open-telemetry#452)

a9e52b8

c24t added a commit that referenced this pull request Mar 3, 2020

Prepare to host on readthedocs.org (#452)

0c46468

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Prepare to host on readthedocs.org #452

Prepare to host on readthedocs.org #452

c24t commented Feb 28, 2020

codecov-io commented Feb 28, 2020 •

edited

Loading

hectorhdzg left a comment

mauriciovasquezbernal commented Mar 2, 2020 •

edited

Loading

codeboten left a comment

c24t commented Mar 2, 2020

c24t commented Mar 2, 2020

Prepare to host on readthedocs.org #452

Prepare to host on readthedocs.org #452

Conversation

c24t commented Feb 28, 2020

codecov-io commented Feb 28, 2020 • edited Loading

Codecov Report

hectorhdzg left a comment

Choose a reason for hiding this comment

mauriciovasquezbernal commented Mar 2, 2020 • edited Loading

codeboten left a comment

Choose a reason for hiding this comment

c24t commented Mar 2, 2020

c24t commented Mar 2, 2020

codecov-io commented Feb 28, 2020 •

edited

Loading

mauriciovasquezbernal commented Mar 2, 2020 •

edited

Loading