Skip to content

Commit 739be94

Browse files
authored
fix typo in readme; use for docs website too (#657)
1 parent a221845 commit 739be94

5 files changed

Lines changed: 16 additions & 33 deletions

File tree

README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ using the `CWL v1.2 schema <https://github.com/common-workflow-language/cwl-v1.2
107107
as an example.
108108

109109
+-------------+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
110-
| Language | Repository | Serialization Example | Deserialization Example |
110+
| Language | Repository | Serialization Example | Deserialization Example |
111111
+=============+=========================================================+======================================================================================================================================================+============================================================================================================================================================================+
112112
| Python | https://github.com/common-workflow-language/cwl-utils/ | `create_cwl_from_objects.py <https://github.com/common-workflow-language/cwl-utils/blob/main/create_cwl_from_objects.py>`_ | `load_document() <https://github.com/common-workflow-language/cwl-utils/blob/main/cwl_utils/parser/__init__.py#L93>`_ |
113113
+-------------+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

docs/cli.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
Command Line Options
2+
====================
3+
4+
.. autoprogram:: schema_salad.main:arg_parser()
5+
:prog: schema-salad-tool
6+
7+
.. autoprogram:: schema_salad.makedoc:arg_parser()
8+
:prog: schema-salad-doc
9+
10+

docs/index.rst

Lines changed: 4 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,11 @@
1-
############################################################################
2-
Schema language for describing JSON or YAML structured linked data documents
3-
############################################################################
4-
5-
Salad is a schema language for describing JSON or YAML structured
6-
linked data documents. Salad schema describes rules for
7-
preprocessing, structural validation, and hyperlink checking for
8-
documents described by a Salad schema. Salad supports rich data
9-
modeling with inheritance, template specialization, object
10-
identifiers, object references, documentation generation, code
11-
generation, and transformation to RDF_. Salad provides a bridge
12-
between document and record oriented data modeling and the Semantic
13-
Web.
14-
15-
Modules
16-
=======
1+
.. include:: ../README.rst
172

183
.. toctree::
194
:maxdepth: 2
205

21-
Command Line Options
22-
====================
23-
24-
.. autoprogram:: schema_salad.main:arg_parser()
25-
:prog: schema-salad-tool
26-
27-
.. autoprogram:: schema_salad.makedoc:arg_parser()
28-
:prog: schema-salad-doc
6+
cli
7+
typeshed
8+
autoapi/index
299

3010
Indices and tables
3111
==================

docs/modules.rst

Lines changed: 0 additions & 7 deletions
This file was deleted.

tox.ini

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,5 +84,5 @@ commands =
8484
deps =
8585
twine
8686
build
87-
readme_renderer[md]
87+
readme_renderer[rst]
8888
skip_install = true

0 commit comments

Comments
 (0)