Skip to content
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

Fix docs pipeline #31

Merged
merged 7 commits into from
Oct 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ name: Build docs

on:
push:
branches:
- main
workflow_dispatch:
inputs:
deploy_docs:
Expand Down Expand Up @@ -32,8 +30,8 @@ jobs:
- name: setup
run: |
# ... installation of all tools ...
sudo apt-get install -y python3-sphinx
sudo pip3 install sphinx-rtd-theme sphinxcontrib-images
sudo apt-get install -y python3-pip
sudo pip3 install sphinx==7.4.7 sphinx-rtd-theme sphinxcontrib-images --break-system-packages

- name: build
run: |
Expand All @@ -45,9 +43,11 @@ jobs:
python3 build_docs.py

- name: Setup Pages
if: github.ref_name == 'main'
uses: actions/configure-pages@v4

- name: Upload artifact
if: github.ref_name == 'main'
uses: actions/upload-pages-artifact@v3
with:
# Upload entire repository
Expand Down
2 changes: 1 addition & 1 deletion docs/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Set up sphinx-autobuild for local development
# Adapted from https://www.rizzonicola.com/posts/sphinx-docker/
FROM sphinxdoc/sphinx
FROM sphinxdoc/sphinx:7.4.7
WORKDIR /etc/
RUN mkdir /source
RUN mkdir /build
Expand Down
16 changes: 9 additions & 7 deletions docs/source/DevelopmentGuide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ The frontend has a number of custom hooks that are used to manage state and side
* Provides a way to manage undo and redo edits

Custom properties and Type-Value notation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Custom properties are stored with their types explicitly recorded.
This is a verbose way to store information, but it ensures that the information can be understood.
Expand Down Expand Up @@ -273,9 +273,10 @@ They may also have a ``resourceId`` property to determine which resource they ar
* ``ResourceChip``
* A generic chip component that can be used to display a resource as a single line of text
* ``ResourceCreator``
* A generic creator component that can be used to create a resource
* ``Mapping``
* A mapping component that can be used to handle adjusting raw File contents to a supported format
* A generic creator component that can be used to create a resource

* ``Mapping``
* A mapping component that can be used to handle adjusting raw File contents to a supported format
* Utilities
* ``LoadingChip``
* A generic loading chip component that can be used to display a loading state
Expand All @@ -287,9 +288,10 @@ They may also have a ``resourceId`` property to determine which resource they ar
* A generic action bar component that can be used to display actions for a resource
* ``NumberInput``
* A generic number input component that can be used to input a number
* ``ResourceStatuses``
* A generic status component that can be used to display a resource's status
* Used to allow quick access to actions that can be taken on a resource

* ``ResourceStatuses``
* A generic status component that can be used to display a resource's status
* Used to allow quick access to actions that can be taken on a resource
* Data display
* The family of components in the ``src/Components/prettify`` directory
* These components are used to display data in a more human-readable form
Expand Down
4 changes: 2 additions & 2 deletions src/test/ResourceCard.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,7 @@ describe('ResourceCard', () => {
expect(input).toHaveValue('')
expect(undo_mk2).toBeEnabled()
check_safe_tooltip_disabled(get_redo_button())
}, 10000)
}, 500000) // Takes forever on MacOS 13 for some reason?

it('supports resetting', async () => {
const confirmSpy = vi.spyOn(window, 'confirm')
Expand Down Expand Up @@ -976,7 +976,7 @@ describe('ResourceCard', () => {
// const row = await setup("key obj", "galv_CELL");
// expect(within(row).getByRole('combobox')).toHaveValue("")
// })
})
}, 500000) // Takes forever on MacOS 13 for some reason?

describe('ResourceCard shows resume for partial Files', () => {
it('shows complete upload button for partial files', async () => {
Expand Down