Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 11 additions & 4 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,16 @@ clean_built:
# Build doc
# ------------------------------------

.PHONY: generate_all_diagrams
## Generate all diagrams, organize them, and clean up in one command
generate_all_diagrams:
@echo "Generating and organizing all diagrams in one step"
./scripts/generate_all_diagrams.sh

.PHONY: generate_doc_content
## Generate documentation content from code and model architectures
## Generate documentation content from code and model architectures (DEPRECATED - use generate_all_diagrams instead)
generate_doc_content:
@echo "NOTE: This target is deprecated. Please use 'make generate_all_diagrams' instead."
@echo "Generating API documentation from docstrings"
mkdir -p docs/generated/api
poetry run python scripts/generate_docstring_docs.py
Expand All @@ -73,7 +80,7 @@ generate_doc_content:

.PHONY: docs_deploy
## Build docs using mike
docs_deploy: generate_doc_content
docs_deploy: generate_all_diagrams
@echo "Starting to build docs"
@echo "more info: https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/"
ifdef HAS_POETRY
Expand All @@ -97,12 +104,12 @@ docs_version_serve:

.PHONY: docs
## Create or Deploy MkDocs based documentation to GitHub pages.
deploy_doc: generate_doc_content
deploy_doc: generate_all_diagrams
mkdocs gh-deploy

.PHONY: serve_doc
## Test MkDocs based documentation locally.
serve_doc: generate_doc_content
serve_doc: generate_all_diagrams
poetry run mkdocs serve

# ------------------------------------
Expand Down
Binary file removed Model_Architecture.png
Binary file not shown.
Binary file modified docs/advanced/imgs/feature_moe.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/examples/imgs/basic_time_series.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/examples/imgs/time_series_all_features.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/examples/imgs/time_series_differencing.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/examples/imgs/time_series_moving_average.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/examples/imgs/time_series_with_lags.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/features/imgs/basic_time_series.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/features/imgs/feature_moe.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/features/imgs/models/all_basic_types.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/features/imgs/models/basic_passthrough.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/features/imgs/models/basic_time_series.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/features/imgs/models/custom_passthrough_feature.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/features/imgs/models/feature_moe.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading