diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 2967456..3af05d1 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -3,8 +3,6 @@ name: Build docs on: push: - branches: - - main workflow_dispatch: inputs: deploy_docs: @@ -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: | @@ -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 diff --git a/docs/Dockerfile b/docs/Dockerfile index 5c91ca5..c73b9c1 100644 --- a/docs/Dockerfile +++ b/docs/Dockerfile @@ -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 diff --git a/docs/source/DevelopmentGuide.rst b/docs/source/DevelopmentGuide.rst index 3da1caf..e2f2f93 100644 --- a/docs/source/DevelopmentGuide.rst +++ b/docs/source/DevelopmentGuide.rst @@ -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. @@ -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 @@ -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 diff --git a/src/test/ResourceCard.test.tsx b/src/test/ResourceCard.test.tsx index 9aba0e6..f458da9 100644 --- a/src/test/ResourceCard.test.tsx +++ b/src/test/ResourceCard.test.tsx @@ -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') @@ -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 () => {