Skip to content

Commit

Permalink
add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@PedramNavid
PedramNavid committed Aug 9, 2024
1 parent dfe6b07 commit 77bbe41
Showing 1 changed file with 16 additions and 6 deletions.
22 changes: 16 additions & 6 deletions docs/sphinx/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,19 @@
<insert>
# Sphinx Documentation
# Dagster API Documentation

Check warning on line 1 in docs/sphinx/README.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Microsoft.HeadingAcronyms] Avoid using acronyms in a title or heading.

Raw Output:
{"message": "[Microsoft.HeadingAcronyms] Avoid using acronyms in a title or heading.", "location": {"path": "docs/sphinx/README.md", "range": {"start": {"line": 1, "column": 11}}}, "severity": "WARNING"}

This directory contains the Sphinx documentation for the project. Below are the available make commands to help you build and manage the documentation.
This directory contains the Sphinx documentation for the Dagster API.
The core API documentation is created in `index.rst` and the files in `sections/api/apidocs`.

## Make Commands
There are currently two workflows for generating the API documentation:

### `help`
Displays a list of available make commands with descriptions.
- The existing workflow uses tox to generate JSON output that is read by our NextJS

Check warning on line 8 in docs/sphinx/README.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.Contractions] Use 'that's' instead of 'that is'.

Raw Output:
{"message": "[Google.Contractions] Use 'that's' instead of 'that is'.", "location": {"path": "docs/sphinx/README.md", "range": {"start": {"line": 8, "column": 58}}}, "severity": "INFO"}

Check warning on line 8 in docs/sphinx/README.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.We] Try to avoid using first-person plural like 'our'.

Raw Output:
{"message": "[Google.We] Try to avoid using first-person plural like 'our'.", "location": {"path": "docs/sphinx/README.md", "range": {"start": {"line": 8, "column": 74}}}, "severity": "WARNING"}
site. Running tox or `make json` will generate JSON output
- The new workflow uses Sphinx to generate HTML output. You can run `make html`
to generate HTML output, and view the static site by opening `build/html/index.html`.

## Development

Run `make install` to install the necessary dependencies for building the documentation.

You can run `make watch` to watch for changes to the API documentation and automatically rebuild the documentation.
Note: some changes might not be reflected immediately, for example style-sheets.
You can run `make clean` and `make html` to force a full rebuild.

0 comments on commit 77bbe41

Please sign in to comment.