Skip to content

[doc] Generate docs for PMD 7#1769

Closed
adangel wants to merge 3 commits into
pmd:pmd/7.0.xfrom
adangel:pmd7-generate-docs
Closed

[doc] Generate docs for PMD 7#1769
adangel wants to merge 3 commits into
pmd:pmd/7.0.xfrom
adangel:pmd7-generate-docs

Conversation

@adangel

@adangel adangel commented Apr 12, 2019

Copy link
Copy Markdown
Member

This adds a travis script, that uploads the documentation and javadoc to

We could add more modules, I've now only added pmd-core and pmd-java separately.

(I've ran the script locally, so there is already documentation uploaded...)

@adangel adangel added this to the 7.0.0 milestone Apr 12, 2019
@ghost

ghost commented Apr 12, 2019

Copy link
Copy Markdown
1 Message
📖 No java rules are changed!

Generated by 🚫 Danger

@jsotuyod jsotuyod left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looking good! This will probably need a new job in Travis to run in parallel.

Comment thread pom.xml Outdated
@oowekyala oowekyala added the is:WIP For PRs that are not fully ready, or issues that are actively being tackled label Apr 27, 2019
@adangel adangel force-pushed the pmd7-generate-docs branch from 9dbafef to 27430b9 Compare June 19, 2019 18:25
@adangel adangel removed the is:WIP For PRs that are not fully ready, or issues that are actively being tackled label Jun 19, 2019
@adangel

adangel commented Jun 19, 2019

Copy link
Copy Markdown
Member Author

I think, this is ready now.

This will probably need a new job in Travis to run in parallel.

It will run at the end of the doc job (.travis/build-doc.sh), so I don't think, another job is necessary.

Comment thread pom.xml
<version>${ant.version}</version>
</additionalDependency>
</additionalDependencies>
<excludePackageNames>*.internal</excludePackageNames>

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Could we also exclude the packages under lang.*.rule.*? IMO the rule implementations should be internal, their Javadoc is irrelevant

adangel added a commit that referenced this pull request Nov 16, 2019
This tries to determine the links to the other reactor projects,
e.g. from pmd-java to pmd-core via the url from project.url.
Project.url is currently https://pmd.github.io and the constructed
url will be https://pmd.github.io/apidocs which doesn't exist.
This means, the generated links to classes e.g. from core don't work
anyway.

Disabling this feature avoids error messages like
[ERROR] Error fetching link: /home/travis/build/pmd/pmd/pmd-apex-jorje/target/apidocs. Ignored it.
E.g. pmd-apex-jorje does not have own javadoc at all, since it is
just a library.

The linking between the different pmd modules needs to be revisited
with #1769.
@adangel

adangel commented Mar 15, 2020

Copy link
Copy Markdown
Member Author

excluding packages should be done on master already now

@adangel

adangel commented Apr 15, 2020

Copy link
Copy Markdown
Member Author

Replaced by #2417

@adangel adangel closed this Apr 15, 2020
@adangel adangel removed this from the 7.0.0 milestone Jan 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants