Automatically generate API reference docs - #1918

Merged
d-v-b merged 11 commits into
zarr-developers:v3from
dstansby:autoapi
Jun 24, 2024
Merged

Automatically generate API reference docs#1918
d-v-b merged 11 commits into
zarr-developers:v3from
dstansby:autoapi

Conversation

@dstansby

@dstansbydstansby commented May 27, 2024•
edited
Loading

Copy link
Copy Markdown
Contributor

This uses sphinx-autoapi to automatically generate API reference for v3, replacing a lot of manually created .rst pages that were present for v2. Currently only for the zarr namespace, but can (and should) be expanded to sub-modules in a follow up PR.

See https://zarr--1918.org.readthedocs.build/en/1918/api/index.html for the current build of this PR; feedback welcome. There are definitely improvements to be made here, but I think worth getting this in as a first go at the API reference.

@dstansbydstansby changed the title Automatically generate API referenceAutomatically generate API reference docsMay 27, 2024
@dstansbydstansby mentioned this pull request May 27, 2024
Merged
6 tasks
@dstansby
dstansbyforce-pushed the autoapi branch 2 times, most recently from f649442 to 7cd3b56CompareMay 28, 2024 15:44
@d-v-b

d-v-b commented Jun 6, 2024

Copy link
Copy Markdown
Contributor

I didn't review this in detail but i like the effort, and auto docs >>> no docs IMO

@dstansby
dstansby marked this pull request as ready for review June 7, 2024 17:18
@d-v-b
d-v-b self-requested a review June 24, 2024 14:23
@d-v-b
d-v-b merged commit 11a959a into zarr-developers:v3Jun 24, 2024
@d-v-b

d-v-b commented Jun 24, 2024

Copy link
Copy Markdown
Contributor

thanks @dstansby !

@dstansby
dstansby deleted the autoapi branch June 24, 2024 14:32
@jakirkham

jakirkham commented Jun 24, 2024

Copy link
Copy Markdown
Member

Thanks all! 🙏

It looks like RTD is failing. Would someone here be able to take a look? 🙂

@d-v-b

d-v-b commented Jun 24, 2024•
edited
Loading

Copy link
Copy Markdown
Contributor

@jakirkham I'm not too familiar with RTD but I can try to sort things out. Can you elaborate on where the problem is evident? E.g., what should I be looking at?

I checked https://zarr.readthedocs.io/en/v3/ and https://zarr.readthedocs.io/en/stable/, both look fine to me

@dstansby

dstansby commented Jun 24, 2024

Copy link
Copy Markdown
ContributorAuthor

See the v3 builds at https://app.readthedocs.org/projects/zarr/builds/. #1985 should be a fix.

@jakirkham

jakirkham commented Jun 24, 2024

Copy link
Copy Markdown
Member

Thank you both! 🙏

Yep David linked the right place to look. As RTD will just show the last successful build, looking at the doc pages themselves is unfortunately not as helpful. Maybe they could have a banner to note the doc builds or failing or something

Have gone ahead and merged David's fix. Let's see if that helps 🍀

@jakirkham

jakirkham commented Jun 24, 2024

Copy link
Copy Markdown
Member

Fixed with PRs:

Doc builds are now passing again! 🎉

dcherian added a commit to dcherian/zarr-python that referenced this pull request Jun 25, 2024
@dcherian
Merge branch 'v3' into hypothesis-tests
3a560ed
* v3: (22 commits)
[v3] `Buffer` ensure correct subclass based on the `BufferPrototype` argument (zarr-developers#1974)
Fix doc build (zarr-developers#1987)
Fix doc build warnings (zarr-developers#1985)
Automatically generate API reference docs (zarr-developers#1918)
Update `RemoteStore.__str__` and add UPath tests (zarr-developers#1964)
[v3] Elevate codec pipeline (zarr-developers#1932)
0 dim arrays: indexing (zarr-developers#1980)
`parse_shapelike` allows 0 (zarr-developers#1979)
Clean up typing and docs for indexing (zarr-developers#1961)
add json indentation to config (zarr-developers#1952)
chore: update pre-commit hooks (zarr-developers#1973)
Bump pypa/gh-action-pypi-publish in the actions group (zarr-developers#1969)
chore: update pre-commit hooks (zarr-developers#1957)
Update release.rst (zarr-developers#1960)
doc: update release notes for 3.0.0.alpha (zarr-developers#1959)
Basic working FsspecStore (zarr-developers#1785)
Feature: Top level V3 API (zarr-developers#1884)
Buffer Prototype Argument (zarr-developers#1910)
Create issue-metrics.yml
fixes bug in transpose (zarr-developers#1949)
...
@dstansbydstansby mentioned this pull request Jun 26, 2024
Closed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@d-v-bd-v-bd-v-b approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@dstansby@d-v-b@jakirkham
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Automatically generate API reference docs - #1918
Merged
d-v-b merged 11 commits into
zarr-developers:v3from 
dstansby:autoapi
Jun 24, 2024
Merged
Automatically generate API reference docs#1918
d-v-b merged 11 commits into
zarr-developers:v3from 
dstansby:autoapi
Conversation
@dstansby
@dstansbydstansby
commented
May 27, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
This uses sphinx-autoapi to automatically generate API reference for v3, replacing a lot of manually created .rst pages that were present for v2. Currently only for the zarr namespace, but can (and should) be expanded to sub-modules in a follow up PR.
See https://zarr--1918.org.readthedocs.build/en/1918/api/index.html for the current build of this PR; feedback welcome. There are definitely improvements to be made here, but I think worth getting this in as a first go at the API reference.
@dstansbydstansby
changed the title
Automatically generate API referenceAutomatically generate API reference docsMay 27, 2024
@dstansbydstansby
mentioned this pull request
May 27, 2024
 Merged

6 tasks
@dstansby
dstansbyforce-pushed
the
autoapi
branch
2 times, most recently
from
f649442 to
7cd3b56CompareMay 28, 2024 15:44
@d-v-b
d-v-b
commented
Jun 6, 2024

Copy link


Copy Markdown

Contributor
I didn't review this in detail but i like the effort, and auto docs >>> no docs IMO
@dstansby
dstansby
marked this pull request as ready for review
June 7, 2024 17:18
@d-v-b
d-v-b
self-requested a review
June 24, 2024 14:23
@d-v-b
d-v-b
merged commit 11a959a
into
zarr-developers:v3Jun 24, 2024
@d-v-b
d-v-b
commented
Jun 24, 2024

Copy link


Copy Markdown

Contributor
thanks @dstansby !
@dstansby
dstansby
deleted the

autoapi

branch
June 24, 2024 14:32
@jakirkham
jakirkham
commented
Jun 24, 2024

Copy link


Copy Markdown

Member
Thanks all! 🙏
It looks like RTD is failing. Would someone here be able to take a look? 🙂
@d-v-b
d-v-b
commented
Jun 24, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
@jakirkham I'm not too familiar with RTD but I can try to sort things out. Can you elaborate on where the problem is evident? E.g., what should I be looking at?
I checked https://zarr.readthedocs.io/en/v3/ and https://zarr.readthedocs.io/en/stable/, both look fine to me
@dstansby
dstansby
commented
Jun 24, 2024

Copy link


Copy Markdown

ContributorAuthor
See the v3 builds at https://app.readthedocs.org/projects/zarr/builds/. #1985 should be a fix.
@jakirkham
jakirkham
commented
Jun 24, 2024

Copy link


Copy Markdown

Member
Thank you both! 🙏
Yep David linked the right place to look. As RTD will just show the last successful build, looking at the doc pages themselves is unfortunately not as helpful. Maybe they could have a banner to note the doc builds or failing or something
Have gone ahead and merged David's fix. Let's see if that helps 🍀
@jakirkham
jakirkham
commented
Jun 24, 2024

Copy link


Copy Markdown

Member
Fixed with PRs:
Doc builds are now passing again! 🎉
dcherian added a commit
to dcherian/zarr-python
that referenced
this pull request
Jun 25, 2024
@dcherian
Merge branch 'v3' into hypothesis-tests
3a560ed
* v3: (22 commits)
[v3] `Buffer` ensure correct subclass based on the `BufferPrototype` argument (zarr-developers#1974)
Fix doc build (zarr-developers#1987)
Fix doc build warnings (zarr-developers#1985)
Automatically generate API reference docs (zarr-developers#1918)
Update `RemoteStore.__str__` and add UPath tests (zarr-developers#1964)
[v3] Elevate codec pipeline (zarr-developers#1932)
0 dim arrays: indexing (zarr-developers#1980)
`parse_shapelike` allows 0 (zarr-developers#1979)
Clean up typing and docs for indexing (zarr-developers#1961)
add json indentation to config (zarr-developers#1952)
chore: update pre-commit hooks (zarr-developers#1973)
Bump pypa/gh-action-pypi-publish in the actions group (zarr-developers#1969)
chore: update pre-commit hooks (zarr-developers#1957)
Update release.rst (zarr-developers#1960)
doc: update release notes for 3.0.0.alpha (zarr-developers#1959)
Basic working FsspecStore (zarr-developers#1785)
Feature: Top level V3 API (zarr-developers#1884)
Buffer Prototype Argument (zarr-developers#1910)
Create issue-metrics.yml
fixes bug in transpose (zarr-developers#1949)
...
@dstansbydstansby
mentioned this pull request
Jun 26, 2024

Closed

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@d-v-bd-v-bd-v-b approved these changes

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@dstansby@d-v-b@jakirkham

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Automatically generate API reference docs - #1918
Merged
d-v-b merged 11 commits into
zarr-developers:v3from 
dstansby:autoapi
Jun 24, 2024
Merged
Automatically generate API reference docs#1918
d-v-b merged 11 commits into
zarr-developers:v3from 
dstansby:autoapi
Conversation
@dstansby
@dstansbydstansby
commented
May 27, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
This uses sphinx-autoapi to automatically generate API reference for v3, replacing a lot of manually created .rst pages that were present for v2. Currently only for the zarr namespace, but can (and should) be expanded to sub-modules in a follow up PR.
See https://zarr--1918.org.readthedocs.build/en/1918/api/index.html for the current build of this PR; feedback welcome. There are definitely improvements to be made here, but I think worth getting this in as a first go at the API reference.
@dstansbydstansby
changed the title
Automatically generate API referenceAutomatically generate API reference docsMay 27, 2024
@dstansbydstansby
mentioned this pull request
May 27, 2024
 Merged

6 tasks
@dstansby
dstansbyforce-pushed
the
autoapi
branch
2 times, most recently
from
f649442 to
7cd3b56CompareMay 28, 2024 15:44
@d-v-b
d-v-b
commented
Jun 6, 2024

Copy link


Copy Markdown

Contributor
I didn't review this in detail but i like the effort, and auto docs >>> no docs IMO
@dstansby
dstansby
marked this pull request as ready for review
June 7, 2024 17:18
@d-v-b
d-v-b
self-requested a review
June 24, 2024 14:23
@d-v-b
d-v-b
merged commit 11a959a
into
zarr-developers:v3Jun 24, 2024
@d-v-b
d-v-b
commented
Jun 24, 2024

Copy link


Copy Markdown

Contributor
thanks @dstansby !
@dstansby
dstansby
deleted the

autoapi

branch
June 24, 2024 14:32
@jakirkham
jakirkham
commented
Jun 24, 2024

Copy link


Copy Markdown

Member
Thanks all! 🙏
It looks like RTD is failing. Would someone here be able to take a look? 🙂
@d-v-b
d-v-b
commented
Jun 24, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
@jakirkham I'm not too familiar with RTD but I can try to sort things out. Can you elaborate on where the problem is evident? E.g., what should I be looking at?
I checked https://zarr.readthedocs.io/en/v3/ and https://zarr.readthedocs.io/en/stable/, both look fine to me
@dstansby
dstansby
commented
Jun 24, 2024

Copy link


Copy Markdown

ContributorAuthor
See the v3 builds at https://app.readthedocs.org/projects/zarr/builds/. #1985 should be a fix.
@jakirkham
jakirkham
commented
Jun 24, 2024

Copy link


Copy Markdown

Member
Thank you both! 🙏
Yep David linked the right place to look. As RTD will just show the last successful build, looking at the doc pages themselves is unfortunately not as helpful. Maybe they could have a banner to note the doc builds or failing or something
Have gone ahead and merged David's fix. Let's see if that helps 🍀
@jakirkham
jakirkham
commented
Jun 24, 2024

Copy link


Copy Markdown

Member
Fixed with PRs:
Doc builds are now passing again! 🎉
dcherian added a commit
to dcherian/zarr-python
that referenced
this pull request
Jun 25, 2024
@dcherian
Merge branch 'v3' into hypothesis-tests
3a560ed
* v3: (22 commits)
[v3] `Buffer` ensure correct subclass based on the `BufferPrototype` argument (zarr-developers#1974)
Fix doc build (zarr-developers#1987)
Fix doc build warnings (zarr-developers#1985)
Automatically generate API reference docs (zarr-developers#1918)
Update `RemoteStore.__str__` and add UPath tests (zarr-developers#1964)
[v3] Elevate codec pipeline (zarr-developers#1932)
0 dim arrays: indexing (zarr-developers#1980)
`parse_shapelike` allows 0 (zarr-developers#1979)
Clean up typing and docs for indexing (zarr-developers#1961)
add json indentation to config (zarr-developers#1952)
chore: update pre-commit hooks (zarr-developers#1973)
Bump pypa/gh-action-pypi-publish in the actions group (zarr-developers#1969)
chore: update pre-commit hooks (zarr-developers#1957)
Update release.rst (zarr-developers#1960)
doc: update release notes for 3.0.0.alpha (zarr-developers#1959)
Basic working FsspecStore (zarr-developers#1785)
Feature: Top level V3 API (zarr-developers#1884)
Buffer Prototype Argument (zarr-developers#1910)
Create issue-metrics.yml
fixes bug in transpose (zarr-developers#1949)
...
@dstansbydstansby
mentioned this pull request
Jun 26, 2024

Closed

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@d-v-bd-v-bd-v-b approved these changes

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@dstansby@d-v-b@jakirkham

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Automatically generate API reference docs - #1918
Merged
d-v-b merged 11 commits into
zarr-developers:v3from 
dstansby:autoapi
Jun 24, 2024
Merged
Automatically generate API reference docs#1918
d-v-b merged 11 commits into
zarr-developers:v3from 
dstansby:autoapi
Conversation
@dstansby
@dstansbydstansby
commented
May 27, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
This uses sphinx-autoapi to automatically generate API reference for v3, replacing a lot of manually created .rst pages that were present for v2. Currently only for the zarr namespace, but can (and should) be expanded to sub-modules in a follow up PR.
See https://zarr--1918.org.readthedocs.build/en/1918/api/index.html for the current build of this PR; feedback welcome. There are definitely improvements to be made here, but I think worth getting this in as a first go at the API reference.
@dstansbydstansby
changed the title
Automatically generate API referenceAutomatically generate API reference docsMay 27, 2024
@dstansbydstansby
mentioned this pull request
May 27, 2024
 Merged

6 tasks
@dstansby
dstansbyforce-pushed
the
autoapi
branch
2 times, most recently
from
f649442 to
7cd3b56CompareMay 28, 2024 15:44
@d-v-b
d-v-b
commented
Jun 6, 2024

Copy link


Copy Markdown

Contributor
I didn't review this in detail but i like the effort, and auto docs >>> no docs IMO
@dstansby
dstansby
marked this pull request as ready for review
June 7, 2024 17:18
@d-v-b
d-v-b
self-requested a review
June 24, 2024 14:23
@d-v-b
d-v-b
merged commit 11a959a
into
zarr-developers:v3Jun 24, 2024
@d-v-b
d-v-b
commented
Jun 24, 2024

Copy link


Copy Markdown

Contributor
thanks @dstansby !
@dstansby
dstansby
deleted the

autoapi

branch
June 24, 2024 14:32
@jakirkham
jakirkham
commented
Jun 24, 2024

Copy link


Copy Markdown

Member
Thanks all! 🙏
It looks like RTD is failing. Would someone here be able to take a look? 🙂
@d-v-b
d-v-b
commented
Jun 24, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
@jakirkham I'm not too familiar with RTD but I can try to sort things out. Can you elaborate on where the problem is evident? E.g., what should I be looking at?
I checked https://zarr.readthedocs.io/en/v3/ and https://zarr.readthedocs.io/en/stable/, both look fine to me
@dstansby
dstansby
commented
Jun 24, 2024

Copy link


Copy Markdown

ContributorAuthor
See the v3 builds at https://app.readthedocs.org/projects/zarr/builds/. #1985 should be a fix.
@jakirkham
jakirkham
commented
Jun 24, 2024

Copy link


Copy Markdown

Member
Thank you both! 🙏
Yep David linked the right place to look. As RTD will just show the last successful build, looking at the doc pages themselves is unfortunately not as helpful. Maybe they could have a banner to note the doc builds or failing or something
Have gone ahead and merged David's fix. Let's see if that helps 🍀
@jakirkham
jakirkham
commented
Jun 24, 2024

Copy link


Copy Markdown

Member
Fixed with PRs:
Doc builds are now passing again! 🎉
dcherian added a commit
to dcherian/zarr-python
that referenced
this pull request
Jun 25, 2024
@dcherian
Merge branch 'v3' into hypothesis-tests
3a560ed
* v3: (22 commits)
[v3] `Buffer` ensure correct subclass based on the `BufferPrototype` argument (zarr-developers#1974)
Fix doc build (zarr-developers#1987)
Fix doc build warnings (zarr-developers#1985)
Automatically generate API reference docs (zarr-developers#1918)
Update `RemoteStore.__str__` and add UPath tests (zarr-developers#1964)
[v3] Elevate codec pipeline (zarr-developers#1932)
0 dim arrays: indexing (zarr-developers#1980)
`parse_shapelike` allows 0 (zarr-developers#1979)
Clean up typing and docs for indexing (zarr-developers#1961)
add json indentation to config (zarr-developers#1952)
chore: update pre-commit hooks (zarr-developers#1973)
Bump pypa/gh-action-pypi-publish in the actions group (zarr-developers#1969)
chore: update pre-commit hooks (zarr-developers#1957)
Update release.rst (zarr-developers#1960)
doc: update release notes for 3.0.0.alpha (zarr-developers#1959)
Basic working FsspecStore (zarr-developers#1785)
Feature: Top level V3 API (zarr-developers#1884)
Buffer Prototype Argument (zarr-developers#1910)
Create issue-metrics.yml
fixes bug in transpose (zarr-developers#1949)
...
@dstansbydstansby
mentioned this pull request
Jun 26, 2024

Closed

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@d-v-bd-v-bd-v-b approved these changes

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@dstansby@d-v-b@jakirkham

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Automatically generate API reference docs - #1918
Merged
d-v-b merged 11 commits into
zarr-developers:v3from 
dstansby:autoapi
Jun 24, 2024
Merged
Automatically generate API reference docs#1918
d-v-b merged 11 commits into
zarr-developers:v3from 
dstansby:autoapi
Conversation
@dstansby
@dstansbydstansby
commented
May 27, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
This uses sphinx-autoapi to automatically generate API reference for v3, replacing a lot of manually created .rst pages that were present for v2. Currently only for the zarr namespace, but can (and should) be expanded to sub-modules in a follow up PR.
See https://zarr--1918.org.readthedocs.build/en/1918/api/index.html for the current build of this PR; feedback welcome. There are definitely improvements to be made here, but I think worth getting this in as a first go at the API reference.
@dstansbydstansby
changed the title
Automatically generate API referenceAutomatically generate API reference docsMay 27, 2024
@dstansbydstansby
mentioned this pull request
May 27, 2024
 Merged

6 tasks
@dstansby
dstansbyforce-pushed
the
autoapi
branch
2 times, most recently
from
f649442 to
7cd3b56CompareMay 28, 2024 15:44
@d-v-b
d-v-b
commented
Jun 6, 2024

Copy link


Copy Markdown

Contributor
I didn't review this in detail but i like the effort, and auto docs >>> no docs IMO
@dstansby
dstansby
marked this pull request as ready for review
June 7, 2024 17:18
@d-v-b
d-v-b
self-requested a review
June 24, 2024 14:23
@d-v-b
d-v-b
merged commit 11a959a
into
zarr-developers:v3Jun 24, 2024
@d-v-b
d-v-b
commented
Jun 24, 2024

Copy link


Copy Markdown

Contributor
thanks @dstansby !
@dstansby
dstansby
deleted the

autoapi

branch
June 24, 2024 14:32
@jakirkham
jakirkham
commented
Jun 24, 2024

Copy link


Copy Markdown

Member
Thanks all! 🙏
It looks like RTD is failing. Would someone here be able to take a look? 🙂
@d-v-b
d-v-b
commented
Jun 24, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
@jakirkham I'm not too familiar with RTD but I can try to sort things out. Can you elaborate on where the problem is evident? E.g., what should I be looking at?
I checked https://zarr.readthedocs.io/en/v3/ and https://zarr.readthedocs.io/en/stable/, both look fine to me
@dstansby
dstansby
commented
Jun 24, 2024

Copy link


Copy Markdown

ContributorAuthor
See the v3 builds at https://app.readthedocs.org/projects/zarr/builds/. #1985 should be a fix.
@jakirkham
jakirkham
commented
Jun 24, 2024

Copy link


Copy Markdown

Member
Thank you both! 🙏
Yep David linked the right place to look. As RTD will just show the last successful build, looking at the doc pages themselves is unfortunately not as helpful. Maybe they could have a banner to note the doc builds or failing or something
Have gone ahead and merged David's fix. Let's see if that helps 🍀
@jakirkham
jakirkham
commented
Jun 24, 2024

Copy link


Copy Markdown

Member
Fixed with PRs:
Doc builds are now passing again! 🎉
dcherian added a commit
to dcherian/zarr-python
that referenced
this pull request
Jun 25, 2024
@dcherian
Merge branch 'v3' into hypothesis-tests
3a560ed
* v3: (22 commits)
[v3] `Buffer` ensure correct subclass based on the `BufferPrototype` argument (zarr-developers#1974)
Fix doc build (zarr-developers#1987)
Fix doc build warnings (zarr-developers#1985)
Automatically generate API reference docs (zarr-developers#1918)
Update `RemoteStore.__str__` and add UPath tests (zarr-developers#1964)
[v3] Elevate codec pipeline (zarr-developers#1932)
0 dim arrays: indexing (zarr-developers#1980)
`parse_shapelike` allows 0 (zarr-developers#1979)
Clean up typing and docs for indexing (zarr-developers#1961)
add json indentation to config (zarr-developers#1952)
chore: update pre-commit hooks (zarr-developers#1973)
Bump pypa/gh-action-pypi-publish in the actions group (zarr-developers#1969)
chore: update pre-commit hooks (zarr-developers#1957)
Update release.rst (zarr-developers#1960)
doc: update release notes for 3.0.0.alpha (zarr-developers#1959)
Basic working FsspecStore (zarr-developers#1785)
Feature: Top level V3 API (zarr-developers#1884)
Buffer Prototype Argument (zarr-developers#1910)
Create issue-metrics.yml
fixes bug in transpose (zarr-developers#1949)
...
@dstansbydstansby
mentioned this pull request
Jun 26, 2024

Closed

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@d-v-bd-v-bd-v-b approved these changes

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@dstansby@d-v-b@jakirkham

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Automatically generate API reference docs - #1918
Merged
d-v-b merged 11 commits into
zarr-developers:v3from 
dstansby:autoapi
Jun 24, 2024
Merged
Automatically generate API reference docs#1918
d-v-b merged 11 commits into
zarr-developers:v3from 
dstansby:autoapi
Conversation
@dstansby
@dstansbydstansby
commented
May 27, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
This uses sphinx-autoapi to automatically generate API reference for v3, replacing a lot of manually created .rst pages that were present for v2. Currently only for the zarr namespace, but can (and should) be expanded to sub-modules in a follow up PR.
See https://zarr--1918.org.readthedocs.build/en/1918/api/index.html for the current build of this PR; feedback welcome. There are definitely improvements to be made here, but I think worth getting this in as a first go at the API reference.
@dstansbydstansby
changed the title
Automatically generate API referenceAutomatically generate API reference docsMay 27, 2024
@dstansbydstansby
mentioned this pull request
May 27, 2024
 Merged

6 tasks
@dstansby
dstansbyforce-pushed
the
autoapi
branch
2 times, most recently
from
f649442 to
7cd3b56CompareMay 28, 2024 15:44
@d-v-b
d-v-b
commented
Jun 6, 2024

Copy link


Copy Markdown

Contributor
I didn't review this in detail but i like the effort, and auto docs >>> no docs IMO
@dstansby
dstansby
marked this pull request as ready for review
June 7, 2024 17:18
@d-v-b
d-v-b
self-requested a review
June 24, 2024 14:23
@d-v-b
d-v-b
merged commit 11a959a
into
zarr-developers:v3Jun 24, 2024
@d-v-b
d-v-b
commented
Jun 24, 2024

Copy link


Copy Markdown

Contributor
thanks @dstansby !
@dstansby
dstansby
deleted the

autoapi

branch
June 24, 2024 14:32
@jakirkham
jakirkham
commented
Jun 24, 2024

Copy link


Copy Markdown

Member
Thanks all! 🙏
It looks like RTD is failing. Would someone here be able to take a look? 🙂
@d-v-b
d-v-b
commented
Jun 24, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
@jakirkham I'm not too familiar with RTD but I can try to sort things out. Can you elaborate on where the problem is evident? E.g., what should I be looking at?
I checked https://zarr.readthedocs.io/en/v3/ and https://zarr.readthedocs.io/en/stable/, both look fine to me
@dstansby
dstansby
commented
Jun 24, 2024

Copy link


Copy Markdown

ContributorAuthor
See the v3 builds at https://app.readthedocs.org/projects/zarr/builds/. #1985 should be a fix.
@jakirkham
jakirkham
commented
Jun 24, 2024

Copy link


Copy Markdown

Member
Thank you both! 🙏
Yep David linked the right place to look. As RTD will just show the last successful build, looking at the doc pages themselves is unfortunately not as helpful. Maybe they could have a banner to note the doc builds or failing or something
Have gone ahead and merged David's fix. Let's see if that helps 🍀
@jakirkham
jakirkham
commented
Jun 24, 2024

Copy link


Copy Markdown

Member
Fixed with PRs:
Doc builds are now passing again! 🎉
dcherian added a commit
to dcherian/zarr-python
that referenced
this pull request
Jun 25, 2024
@dcherian
Merge branch 'v3' into hypothesis-tests
3a560ed
* v3: (22 commits)
[v3] `Buffer` ensure correct subclass based on the `BufferPrototype` argument (zarr-developers#1974)
Fix doc build (zarr-developers#1987)
Fix doc build warnings (zarr-developers#1985)
Automatically generate API reference docs (zarr-developers#1918)
Update `RemoteStore.__str__` and add UPath tests (zarr-developers#1964)
[v3] Elevate codec pipeline (zarr-developers#1932)
0 dim arrays: indexing (zarr-developers#1980)
`parse_shapelike` allows 0 (zarr-developers#1979)
Clean up typing and docs for indexing (zarr-developers#1961)
add json indentation to config (zarr-developers#1952)
chore: update pre-commit hooks (zarr-developers#1973)
Bump pypa/gh-action-pypi-publish in the actions group (zarr-developers#1969)
chore: update pre-commit hooks (zarr-developers#1957)
Update release.rst (zarr-developers#1960)
doc: update release notes for 3.0.0.alpha (zarr-developers#1959)
Basic working FsspecStore (zarr-developers#1785)
Feature: Top level V3 API (zarr-developers#1884)
Buffer Prototype Argument (zarr-developers#1910)
Create issue-metrics.yml
fixes bug in transpose (zarr-developers#1949)
...
@dstansbydstansby
mentioned this pull request
Jun 26, 2024

Closed

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@d-v-bd-v-bd-v-b approved these changes

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@dstansby@d-v-b@jakirkham

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Automatically generate API reference docs - #1918
Merged
d-v-b merged 11 commits into
zarr-developers:v3from 
dstansby:autoapi
Jun 24, 2024
Merged
Automatically generate API reference docs#1918
d-v-b merged 11 commits into
zarr-developers:v3from 
dstansby:autoapi
Conversation
@dstansby
@dstansbydstansby
commented
May 27, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
This uses sphinx-autoapi to automatically generate API reference for v3, replacing a lot of manually created .rst pages that were present for v2. Currently only for the zarr namespace, but can (and should) be expanded to sub-modules in a follow up PR.
See https://zarr--1918.org.readthedocs.build/en/1918/api/index.html for the current build of this PR; feedback welcome. There are definitely improvements to be made here, but I think worth getting this in as a first go at the API reference.
@dstansbydstansby
changed the title
Automatically generate API referenceAutomatically generate API reference docsMay 27, 2024
@dstansbydstansby
mentioned this pull request
May 27, 2024
 Merged

6 tasks
@dstansby
dstansbyforce-pushed
the
autoapi
branch
2 times, most recently
from
f649442 to
7cd3b56CompareMay 28, 2024 15:44
@d-v-b
d-v-b
commented
Jun 6, 2024

Copy link


Copy Markdown

Contributor
I didn't review this in detail but i like the effort, and auto docs >>> no docs IMO
@dstansby
dstansby
marked this pull request as ready for review
June 7, 2024 17:18
@d-v-b
d-v-b
self-requested a review
June 24, 2024 14:23
@d-v-b
d-v-b
merged commit 11a959a
into
zarr-developers:v3Jun 24, 2024
@d-v-b
d-v-b
commented
Jun 24, 2024

Copy link


Copy Markdown

Contributor
thanks @dstansby !
@dstansby
dstansby
deleted the

autoapi

branch
June 24, 2024 14:32
@jakirkham
jakirkham
commented
Jun 24, 2024

Copy link


Copy Markdown

Member
Thanks all! 🙏
It looks like RTD is failing. Would someone here be able to take a look? 🙂
@d-v-b
d-v-b
commented
Jun 24, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
@jakirkham I'm not too familiar with RTD but I can try to sort things out. Can you elaborate on where the problem is evident? E.g., what should I be looking at?
I checked https://zarr.readthedocs.io/en/v3/ and https://zarr.readthedocs.io/en/stable/, both look fine to me
@dstansby
dstansby
commented
Jun 24, 2024

Copy link


Copy Markdown

ContributorAuthor
See the v3 builds at https://app.readthedocs.org/projects/zarr/builds/. #1985 should be a fix.
@jakirkham
jakirkham
commented
Jun 24, 2024

Copy link


Copy Markdown

Member
Thank you both! 🙏
Yep David linked the right place to look. As RTD will just show the last successful build, looking at the doc pages themselves is unfortunately not as helpful. Maybe they could have a banner to note the doc builds or failing or something
Have gone ahead and merged David's fix. Let's see if that helps 🍀
@jakirkham
jakirkham
commented
Jun 24, 2024

Copy link


Copy Markdown

Member
Fixed with PRs:
Doc builds are now passing again! 🎉
dcherian added a commit
to dcherian/zarr-python
that referenced
this pull request
Jun 25, 2024
@dcherian
Merge branch 'v3' into hypothesis-tests
3a560ed
* v3: (22 commits)
[v3] `Buffer` ensure correct subclass based on the `BufferPrototype` argument (zarr-developers#1974)
Fix doc build (zarr-developers#1987)
Fix doc build warnings (zarr-developers#1985)
Automatically generate API reference docs (zarr-developers#1918)
Update `RemoteStore.__str__` and add UPath tests (zarr-developers#1964)
[v3] Elevate codec pipeline (zarr-developers#1932)
0 dim arrays: indexing (zarr-developers#1980)
`parse_shapelike` allows 0 (zarr-developers#1979)
Clean up typing and docs for indexing (zarr-developers#1961)
add json indentation to config (zarr-developers#1952)
chore: update pre-commit hooks (zarr-developers#1973)
Bump pypa/gh-action-pypi-publish in the actions group (zarr-developers#1969)
chore: update pre-commit hooks (zarr-developers#1957)
Update release.rst (zarr-developers#1960)
doc: update release notes for 3.0.0.alpha (zarr-developers#1959)
Basic working FsspecStore (zarr-developers#1785)
Feature: Top level V3 API (zarr-developers#1884)
Buffer Prototype Argument (zarr-developers#1910)
Create issue-metrics.yml
fixes bug in transpose (zarr-developers#1949)
...
@dstansbydstansby
mentioned this pull request
Jun 26, 2024

Closed

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@d-v-bd-v-bd-v-b approved these changes

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@dstansby@d-v-b@jakirkham

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Automatically generate API reference docs - #1918
Merged
d-v-b merged 11 commits into
zarr-developers:v3from 
dstansby:autoapi
Jun 24, 2024
Merged
Automatically generate API reference docs#1918
d-v-b merged 11 commits into
zarr-developers:v3from 
dstansby:autoapi
Conversation
@dstansby
@dstansbydstansby
commented
May 27, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
This uses sphinx-autoapi to automatically generate API reference for v3, replacing a lot of manually created .rst pages that were present for v2. Currently only for the zarr namespace, but can (and should) be expanded to sub-modules in a follow up PR.
See https://zarr--1918.org.readthedocs.build/en/1918/api/index.html for the current build of this PR; feedback welcome. There are definitely improvements to be made here, but I think worth getting this in as a first go at the API reference.
@dstansbydstansby
changed the title
Automatically generate API referenceAutomatically generate API reference docsMay 27, 2024
@dstansbydstansby
mentioned this pull request
May 27, 2024
 Merged

6 tasks
@dstansby
dstansbyforce-pushed
the
autoapi
branch
2 times, most recently
from
f649442 to
7cd3b56CompareMay 28, 2024 15:44
@d-v-b
d-v-b
commented
Jun 6, 2024

Copy link


Copy Markdown

Contributor
I didn't review this in detail but i like the effort, and auto docs >>> no docs IMO
@dstansby
dstansby
marked this pull request as ready for review
June 7, 2024 17:18
@d-v-b
d-v-b
self-requested a review
June 24, 2024 14:23
@d-v-b
d-v-b
merged commit 11a959a
into
zarr-developers:v3Jun 24, 2024
@d-v-b
d-v-b
commented
Jun 24, 2024

Copy link


Copy Markdown

Contributor
thanks @dstansby !
@dstansby
dstansby
deleted the

autoapi

branch
June 24, 2024 14:32
@jakirkham
jakirkham
commented
Jun 24, 2024

Copy link


Copy Markdown

Member
Thanks all! 🙏
It looks like RTD is failing. Would someone here be able to take a look? 🙂
@d-v-b
d-v-b
commented
Jun 24, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
@jakirkham I'm not too familiar with RTD but I can try to sort things out. Can you elaborate on where the problem is evident? E.g., what should I be looking at?
I checked https://zarr.readthedocs.io/en/v3/ and https://zarr.readthedocs.io/en/stable/, both look fine to me
@dstansby
dstansby
commented
Jun 24, 2024

Copy link


Copy Markdown

ContributorAuthor
See the v3 builds at https://app.readthedocs.org/projects/zarr/builds/. #1985 should be a fix.
@jakirkham
jakirkham
commented
Jun 24, 2024

Copy link


Copy Markdown

Member
Thank you both! 🙏
Yep David linked the right place to look. As RTD will just show the last successful build, looking at the doc pages themselves is unfortunately not as helpful. Maybe they could have a banner to note the doc builds or failing or something
Have gone ahead and merged David's fix. Let's see if that helps 🍀
@jakirkham
jakirkham
commented
Jun 24, 2024

Copy link


Copy Markdown

Member
Fixed with PRs:
Doc builds are now passing again! 🎉
dcherian added a commit
to dcherian/zarr-python
that referenced
this pull request
Jun 25, 2024
@dcherian
Merge branch 'v3' into hypothesis-tests
3a560ed
* v3: (22 commits)
[v3] `Buffer` ensure correct subclass based on the `BufferPrototype` argument (zarr-developers#1974)
Fix doc build (zarr-developers#1987)
Fix doc build warnings (zarr-developers#1985)
Automatically generate API reference docs (zarr-developers#1918)
Update `RemoteStore.__str__` and add UPath tests (zarr-developers#1964)
[v3] Elevate codec pipeline (zarr-developers#1932)
0 dim arrays: indexing (zarr-developers#1980)
`parse_shapelike` allows 0 (zarr-developers#1979)
Clean up typing and docs for indexing (zarr-developers#1961)
add json indentation to config (zarr-developers#1952)
chore: update pre-commit hooks (zarr-developers#1973)
Bump pypa/gh-action-pypi-publish in the actions group (zarr-developers#1969)
chore: update pre-commit hooks (zarr-developers#1957)
Update release.rst (zarr-developers#1960)
doc: update release notes for 3.0.0.alpha (zarr-developers#1959)
Basic working FsspecStore (zarr-developers#1785)
Feature: Top level V3 API (zarr-developers#1884)
Buffer Prototype Argument (zarr-developers#1910)
Create issue-metrics.yml
fixes bug in transpose (zarr-developers#1949)
...
@dstansbydstansby
mentioned this pull request
Jun 26, 2024

Closed

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@d-v-bd-v-bd-v-b approved these changes

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@dstansby@d-v-b@jakirkham