Skip to content

HTML documentation #103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 29 commits into from
Mar 14, 2024
Merged
Show file tree
Hide file tree
Changes from 24 commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
7998fad
Add skeleton for HTML documentaion
asmeurer Mar 8, 2024
bdb6c9c
Move README contents to index.md
asmeurer Mar 8, 2024
a648ffd
Split the docs into multiple pages
asmeurer Mar 8, 2024
749c387
Fix displaying the version in the docs
asmeurer Mar 8, 2024
b9380d4
Add a GitHub icon to the docs
asmeurer Mar 8, 2024
3ae70f6
Add something to the dev docs index page
asmeurer Mar 8, 2024
d557948
Write some dev docs, and various other improvements to the documentation
asmeurer Mar 9, 2024
667a8cb
Use autodoc for helper functions
asmeurer Mar 9, 2024
9904b08
Some improvements to the releasing docs
asmeurer Mar 11, 2024
e328261
Update some implementation notes text
asmeurer Mar 11, 2024
2783a15
Small cleanups to implementation notes
asmeurer Mar 13, 2024
dd1ad48
Add a section explaining the scope of the library
asmeurer Mar 13, 2024
f66b8ac
Fix cross-reference
asmeurer Mar 13, 2024
95395bc
Fix cross-references to helper functions and some RST issues
asmeurer Mar 13, 2024
71906ba
Just refer to the library as "array-api-compat"
asmeurer Mar 13, 2024
0896b3d
Add a favicon
asmeurer Mar 13, 2024
1062501
Add docs build and deploy workflow
asmeurer Mar 13, 2024
99e663d
Allow docs to deploy from this branch to see if it works
asmeurer Mar 13, 2024
3585a8a
Disable Furo fancy scroll behavior
asmeurer Mar 13, 2024
1344568
Use intersphinx instead of links to other docs' URLs
asmeurer Mar 13, 2024
1321368
Clear most of the README content and point to the docs
asmeurer Mar 13, 2024
2222455
Don't force push to gh-pages
asmeurer Mar 14, 2024
fd4b0ed
Add CONTRIBUTING.md
asmeurer Mar 14, 2024
fe645ff
Some small docs changes
asmeurer Mar 14, 2024
0f7fdad
Revert "Allow docs to deploy from this branch to see if it works"
asmeurer Mar 14, 2024
00d025d
Use better header name
asmeurer Mar 14, 2024
c68389e
Fix some RST syntax
asmeurer Mar 14, 2024
8ae7ea4
Split implementation notes into separate pages
asmeurer Mar 14, 2024
3d38978
Use bold instead of italics for the special considerations
asmeurer Mar 14, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Docs
on: [push, pull_request]
jobs:
docs:
runs-on: ubuntu-latest
strategy:
fail-fast: false
environment:
name: docs-build-and-deploy
steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v2
- name: Install Dependencies
run: |
python -m pip install -r docs/requirements.txt

- name: Build Docs
run: |
cd docs
make html

# Note, the gh-pages deployment requires setting up a SSH deploy key.
# See
# https://github.com/JamesIves/github-pages-deploy-action/tree/dev#using-an-ssh-deploy-key-
- name: Deploy
uses: JamesIves/github-pages-deploy-action@v4
if: ${{ github.ref == 'refs/heads/docs' }}
with:
folder: docs/_build/html
ssh-key: ${{ secrets.DEPLOY_KEY }}
force: no
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Contributions to array-api-compat are welcome, so long as they are [in
scope](https://data-apis.org/array-api-compat/index.html#scope).

Contributors are encouraged to read through the [development
notes](https://data-apis.org/array-api-compat/dev/index.html) for the package
to get full context on some of the design decisions and implementation
details used in the codebase.
Loading
Loading