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.

Sign up for GitHub

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

feat: update doc build and deploy process #2882

Merged
merged 1 commit into from
Jan 17, 2025
Merged

feat: update doc build and deploy process #2882

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 6 additions & 6 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,17 +23,17 @@ check_dev_env:
./scripts/check_dev_env.sh


# generate sphinx documentation
.PHONY: doc
doc:
# build sphinx documentation
.PHONY: build_doc
build_doc:
mkdir -p src_docs/build
$(MAKE) -C src_docs clean
$(MAKE) -C src_docs html


# generate and deploy sphinx documentation
.PHONY: doc_deploy
doc_deploy:
# build and deploy sphinx documentation
.PHONY: doc
doc:
./scripts/deploy_doc.sh

# run tests
Expand Down
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ Restaring the running development cluster is useful mainly when using the "conwa
To check that the development environment was correctly setup, run the `make check_dev_env` script.

```text
$ make ./check_dev_env
$ make check_dev_env
./scripts/check_dev_env.sh
'cardano-node' available: ✔
'cardano-cli' available: ✔
Expand Down Expand Up @@ -350,7 +350,7 @@ Edit `pyproject.toml` and run
Build and deploy documentation:

```sh
make deploy_doc
make doc
```

## Contributing
Expand Down
4 changes: 2 additions & 2 deletions scripts/deploy_doc.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ if ! git diff-index --quiet HEAD --; then
fi

# build documentation
make doc
make build_doc

# drop changes made automatically by `make doc`
# drop changes made automatically by `make build_doc`
if ! git diff-index --quiet HEAD -- "$DOC_SRC"; then
git stash -- "$DOC_SRC"
git stash drop
Expand Down
Loading