Skip to content
This repository has been archived by the owner on Oct 12, 2022. It is now read-only.

Turn on markdown for druntime doc build #3016

Merged
merged 1 commit into from Apr 3, 2020

Conversation

schveiguy
Copy link
Member

@schveiguy schveiguy commented Apr 1, 2020

I want to use the auto tester to see what happens when we turn on markdown. Don't merge, I may have to fix things first.

@dlang-bot dlang-bot added the WIP Work In Progress - not ready for review or pulling label Apr 1, 2020
@dlang-bot
Copy link
Contributor

Thanks for your pull request, @schveiguy!

Bugzilla references

Your PR doesn't reference any Bugzilla issue.

If your PR contains non-trivial changes, please reference a Bugzilla issue or create a manual changelog.

Testing this PR locally

If you don't have a local development environment setup, you can use Digger to test this PR:

dub run digger -- build "master + druntime#3016"

@schveiguy schveiguy changed the title [WIP] Try turning on markdown Turn on markdown for druntime doc build Apr 1, 2020
@schveiguy
Copy link
Member Author

OK I think as long as the docs come out OK, this is mergeable.

@schveiguy
Copy link
Member Author

Hm... the ddox changed, how is that generated? I don't see anything in the makefile. The change is slightly worse than the original, but the original sucked too.

@schveiguy
Copy link
Member Author

Even with the ddox change, I think this is good to merge.

@PetarKirov
Copy link
Member

@schveiguy
Copy link
Member Author

@PetarKirov thanks!

Hm.. not sure I can do anything. It looks like json output doesn't spit out markdown results.

@PetarKirov
Copy link
Member

@schveiguy Actually the -preview=markdown flag shouldn't affect Ddox at all, since Ddox has its own parsing based on the json files output from dmd and and libdparse. Additionally it has its own macro engine for Ddoc: https://github.com/rejectedsoftware/ddox/blob/master/source/ddox/ddoc.d

Copy link
Member

@PetarKirov PetarKirov left a comment

Choose a reason for hiding this comment

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

LGTM modulo one question:

src/rt/dwarfeh.d Show resolved Hide resolved
@schveiguy schveiguy removed the WIP Work In Progress - not ready for review or pulling label Apr 2, 2020
@dlang-bot dlang-bot merged commit eb6911e into dlang:master Apr 3, 2020
@schveiguy schveiguy deleted the fixmarkdown branch April 3, 2020 15:07
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
4 participants