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

Use project scope for mdoc sources setting, not ThisBuild #357

Merged
merged 1 commit into from
Nov 5, 2019
Merged

Use project scope for mdoc sources setting, not ThisBuild #357

merged 1 commit into from
Nov 5, 2019

Conversation

pdalpra
Copy link
Contributor

@pdalpra pdalpra commented Nov 4, 2019

This fixes an issue in sbt-microsites where mdoc would always look for sources in a docs folder at the root of the sbt build, instead of a looking for it in the module's base directory.

@pdalpra
Copy link
Contributor Author

pdalpra commented Nov 4, 2019

The build failure is linked to a test compilation error.
I opened #358 with a fix for it.

@juanpedromoreno
Copy link
Member

Hi @pdalpra , thanks for your time. I've just merged #359, could you please rebase against master? Thanks!

@pdalpra
Copy link
Contributor Author

pdalpra commented Nov 4, 2019

No problem, I just rebased this PR on master and closed #358, obsoleted by the revert

@pdalpra
Copy link
Contributor Author

pdalpra commented Nov 4, 2019

Forgot to mention, but I tested this PR locally by overriding mdocIn in my build.

It seems however than mdoc leaves many warnings as it detects links to other pages that are not yet built as 'unknown', but I don't know mdoc well enough to see if there is something to do about it or if I misconfigured it 🤔

@pdalpra
Copy link
Contributor Author

pdalpra commented Nov 5, 2019

After checking mdoc documentation, these warnings can be avoided by disabling link hygiene:

mdocExtraArguments += "--no-link-hygiene"

@juanpedromoreno
Copy link
Member

Thanks @pdalpra !

@juanpedromoreno juanpedromoreno merged commit 64e942a into 47degrees:master Nov 5, 2019
@calvellido calvellido mentioned this pull request Dec 2, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants