pythondrivendataorg/cloudpathlib #211Not a task: already works

Fix API Reference header formatting for Intersphinx

envgap__drivendataorg__cloudpathlib-211

Original GitHub issue ↗Dated source checkout ↗Opened 2022-02-19

01 / FAILURE SIGNATURE

As reported upstream

No identifying execution failure has been captured.

Not a benchmark task.

The project already builds and runs before the fix, so there is nothing to repair.

02 / ENVIRONMENT RECIPE

Base commit: 7e0356cfd80b131e03593a0727a3ca077e67c9fe
Manifest: requirements-dev.txt
Reproduce: Awaiting issue-specific recipe
Run under trace: Awaiting a meaningful runtime command

03 / ORIGINAL ISSUE TEXT

drivendataorg/cloudpathlib #211 · read the original issue

It would be nice if the documentation published an intersphinx `objects.inv` file so that other projects

can use it for cross linking in their documentation.



This only will require adding `enable_inventory` to the `mkdocstrings` configuration in `mkdocs.yml`:



```yaml

  - mkdocstrings:

      # generate objects.inv sphinx inventory file in site/ dir to support external cross references

      enable_inventory: true

```



See https://mkdocstrings.github.io/usage/#cross-references-to-other-projects-inventories

Continue on GitHub ↗

04 / LABELS

Labels from the report text only; not yet run

No supported category has been assigned.

Label rules and the text that matched

[]