Skip to content

Commit

Permalink
docs(sphinx): use relative links to _static folder
Browse files Browse the repository at this point in the history
closes #66
  • Loading branch information
AntoineDao committed May 22, 2020
1 parent d2821e1 commit 9276b6e
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 15 deletions.
6 changes: 3 additions & 3 deletions docs/guides/operator.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Configuration
The ``config.yaml`` file contains information to indicate what underlying software should execute
the operator's functions. We will be focusing on the ``docker`` configuration.

You can check the full schema definition for an Operator Config `here </_static/redoc-operator.html#tag/config_model>`_
You can check the full schema definition for an Operator Config `here <../../_static/redoc-operator.html#tag/config_model>`_

Docker Config
^^^^^^^^^^^^^
Expand Down Expand Up @@ -78,7 +78,7 @@ The file currently contains name and version information:
version: 0.1.0
These are the two mandatory fields for this file. You can view a full list of other available
fields `here </_static/redoc-operator.html#tag/metadata_model>`_.
fields `here <../../_static/redoc-operator.html#tag/metadata_model>`_.

We will be adding a few more fields for demonstration purposes. Overwrite the contents of
``operator.yaml`` with the YAML code block below.
Expand All @@ -91,7 +91,7 @@ Your First Function
-------------------
We are now finally ready to write a Function. Functions are the key ingredients of an Operator. A Function
defines a parametrized command run in a terminal. You can refer to the
`function schema definition </_static/redoc-operator.html#tag/function_model>`_ to understand the components of a function.
`function schema definition <../../_static/redoc-operator.html#tag/function_model>`_ to understand the components of a function.


We listed some function we wanted to create based on examples provided by the EneryPlus documentation.
Expand Down
8 changes: 4 additions & 4 deletions docs/schemas/operators.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Schema
NProgress.start();
</script>
<script>
jsonSchemaViewer(window, '/_static/schemas/operator-schema.json')
jsonSchemaViewer(window, '../../_static/schemas/operator-schema.json')
</script>
<script>
NProgress.done();
Expand All @@ -40,15 +40,15 @@ Schema

OpenAPI Docs
-------------
You can find the Open API Docs formatted by redoc `here </_static/redoc-operator.html#tag/operator_model>`_.
You can find the Open API Docs formatted by redoc `here <../../_static/redoc-operator.html#tag/operator_model>`_.

OpenAPI Definition
-------------------
You can find the OpenAPI JSON definition `here </_static/schemas/operator-openapi.json>`_.
You can find the OpenAPI JSON definition `here <../../_static/schemas/operator-openapi.json>`_.

JSON Schema Definition
-----------------------
You can find the JSON Schema definition `here </_static/schemas/operator-schema.json>`_.
You can find the JSON Schema definition `here <../../_static/schemas/operator-schema.json>`_.

Examples
--------
Expand Down
8 changes: 4 additions & 4 deletions docs/schemas/recipes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Schema
NProgress.start();
</script>
<script>
jsonSchemaViewer(window, '/_static/schemas/recipe-schema.json')
jsonSchemaViewer(window, '../../_static/schemas/recipe-schema.json')
</script>
<script>
NProgress.done();
Expand All @@ -40,15 +40,15 @@ Schema

OpenAPI Docs
-------------
You can find the Open API Docs formatted by redoc `here </_static/redoc-recipe.html#tag/recipe_model>`_.
You can find the Open API Docs formatted by redoc `here <../../_static/redoc-recipe.html#tag/recipe_model>`_.

OpenAPI Definition
-------------------
You can find the OpenAPI JSON definition `here </_static/schemas/recipe-openapi.json>`_.
You can find the OpenAPI JSON definition `here <../../_static/schemas/recipe-openapi.json>`_.

JSON Schema Definition
-----------------------
You can find the JSON Schema definition `here </_static/schemas/recipe-schema.json>`_.
You can find the JSON Schema definition `here <../../_static/schemas/recipe-schema.json>`_.


Examples
Expand Down
8 changes: 4 additions & 4 deletions docs/schemas/workflows.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Schema
NProgress.start();
</script>
<script>
jsonSchemaViewer(window, '/_static/schemas/workflow-schema.json')
jsonSchemaViewer(window, '../../_static/schemas/workflow-schema.json')
</script>
<script>
NProgress.done();
Expand All @@ -40,15 +40,15 @@ Schema

OpenAPI Docs
-------------
You can find the Open API Docs formatted by redoc `here </_static/redoc-workflow.html#tag/workflow_model>`_.
You can find the Open API Docs formatted by redoc `here <../../_static/redoc-workflow.html#tag/workflow_model>`_.

OpenAPI Definition
-------------------
You can find the OpenAPI JSON definition `here </_static/schemas/workflow-openapi.json>`_.
You can find the OpenAPI JSON definition `here <../../_static/schemas/workflow-openapi.json>`_.

JSON Schema Definition
-----------------------
You can find the JSON Schema definition `here </_static/schemas/workflow-schema.json>`_.
You can find the JSON Schema definition `here <../../_static/schemas/workflow-schema.json>`_.


Examples
Expand Down

0 comments on commit 9276b6e

Please sign in to comment.