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.

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

Adds javadoc generator test #1182

Merged
merged 9 commits into from
Jul 6, 2022
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
5 changes: 4 additions & 1 deletion .github/workflows/generator.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,12 @@ jobs:
git diff --cached --exit-code
git diff --exit-code

- name: Generate html
- name: Generate html for python
run: make html-python # emits python/docs/build/html, not checked in

- name: Generate javadocs for java
run: make javadocs # emits java/build/docs/javadoc, not used

- name: Installing pdf dependencies
run: |
sudo apt-get install -y texlive-latex-extra texlive-fonts-extra texlive-science graphviz
Expand Down
5 changes: 5 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -504,6 +504,11 @@ java-examples:
cd $(SWIFTNAV_ROOT)/java/example && gradle clean fatjar
$(call announce-end,"Finished building fat jar")

javadoc javadocs:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could make the dependency of the Java target so that it runs locally-- would there be any downsides to that?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As in - instead of the additional workflow we just add make javadocs to make java or make test-java when it is locally ran?
Not sure if the make javadocs is necessary overall - just to verify whether there are any errors preventing javadocs built when publishing i.e. #1180 probably not needed since errors should rarely occur(?) so can probably close this PR

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If errors are rare then this is a good place to verify, making everyone check it locally sounds unnecessary

$(call announce-begin,"Building javadocs")
cd $(SWIFTNAV_ROOT)/java && gradle javadoc --stacktrace
$(call announce-end,"Finished building javadocs")

spec-validator-fmt:
python -m black scripts/spec_validator.py

Expand Down