Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Recommendations for domain-specific accessor documentation

See original GitHub issue

Hi,

I’m currently working on an ocean domain specific accessor for a machine learning technique (https://github.com/gmaze/pyxpcm/tree/nfeatures).
I implemented an xarray.DataSet accessor (name space pyxpcm) that I’d like to document.

I thus wonder whether the xarray/pangeo community has recommendations about how to do this appropriately ?

Right now, I simply have an API auto-generated page, see: https://pyxpcm-dev.readthedocs.io/en/latest/api.html#xarray-dataset-accessor-the-pyxpcm-name-space

Issue Analytics

State:
Created 4 years ago
Comments:6 (4 by maintainers)

Top GitHub Comments

3reactions

keewiscommented, Jul 2, 2020

I created such a package since I think I’m going to need that for pint-xarray. It currently lives at https://github.com/keewis/sphinx-autosummary-accessors

3reactions

benbovycommented, Apr 23, 2020

I think to make this a bit easier for everyone we should add this to the documentation on accessors.

Agreed, this would definitely be useful.

Also, we could create a sphinx extension module that contains all the code in conf.py

I also agree! Since the code in conf.py is exactly the same for both pandas and xarray, it would be nice to hear thoughts from pandas developers @jorisvandenbossche.

Top Results From Across the Web

Configuration Guide - CIS-CAT Pro Assessor v4

CIS recommends utilizing domain accounts when performing remote assessments. See the section below for security considerations when connecting to the endpoint.

DD or RC (Rule 185) Process Guidelines with MnCHOICEDS

Therefore, with MnCHOICES, this process includes a MnCHOICES assessment by a certified assessor and a determination by a Qualified Developmental Disabilities.

County Assessor's Manual

County Assessor's Reference Manual for Washington State. Specific functions of the county clerk include: •. Administrator of the Court Records and Exhibits: ...

2023 Property Assessment Process Guide for Municipal Officials

This document provides information on the assessment ... Assessor reviews for unusable sales, incorrectly posted assessments and typos . March – end of....

Qualification Requirements - PCI Security Standards Council

PCI DSS Qualification Requirements for Qualified Security Assessors v3.0 ... described in this document and related PCI SSC publications (the “QSA Program”) ...