Compare commits

...

3 Commits

Author SHA1 Message Date
Alex Bäuerle
a2b49525ae install markdown 2024-05-01 11:06:55 -07:00
Alex Bäuerle
478ebedd41 Merge remote-tracking branch 'origin' into ab-docs-remove 2024-05-01 10:35:11 -07:00
Alex Bäuerle
016a56a3d9 ci(docs): remove and rebuild docs to make sure we're getting rid of files that are not there anymore
This is not ideal in that we have to regenerate the whole docs everytime but considering 1. it's pretty fast and 2. it seems to be the only way to ensure consistency it's probably worth doing it this way.
2024-05-01 10:32:09 -07:00
3 changed files with 15 additions and 3 deletions

View File

@@ -235,6 +235,12 @@ clean:
@rm -rf opendevin/.cache
@echo "$(GREEN)Caches cleaned up successfully.$(RESET)"
python-docs:
@echo "$(YELLOW)Generating documentation...$(RESET)"
@rm -rf docs/modules/python
@pydoc-markdown
@echo "$(GREEN)Documentation generated successfully.$(RESET)"
# Help
help:
@echo "$(BLUE)Usage: make [target]$(RESET)"

View File

@@ -42,7 +42,11 @@ repos:
always_run: true
pass_filenames: false
- repo: https://github.com/NiklasRosenstein/pydoc-markdown
rev: develop
- repo: local
hooks:
- id: pydoc-markdown
- id: pydoc
name: pydoc
entry: ./dev_config/python/pydoc.sh
language: script
types: [python]
pass_filenames: false

2
dev_config/python/pydoc.sh Executable file
View File

@@ -0,0 +1,2 @@
#!/bin/bash
pip install pydoc-markdown && rm -rf ./docs/modules/python && pydoc-markdown