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

druntime docs generator: replaces src/* by import/* #15880

Merged
merged 2 commits into from Dec 13, 2023

Conversation

denizzzka
Copy link
Contributor

@denizzzka denizzzka commented Dec 4, 2023

Actually, we want to generate documentation for modules that user can import. Files from import/ are almost same files as in src/.

This may help us to avoid tricky errors related to documenting inaccessible for end users modules (as rt.llmath module, which is not copied into import/ and yet presented in mak/DOCS)

My motivation for this PR: this is need for #15822 - switchable OS-depended source files is too hard to use for docs generation.

The fact is that the paths of these modules are differ depending on the target system. And only import/ dir contains them always at same places because they are automatically copied into import/ as usual

(If #15822 will be accepted it opens way to generate sub-documents for each OS-specific module by a single pass)

Caution! PR changes site links!

-	<div class="tip smallprint">		<a href="https://github.com/dlang/druntime/edit/master/src/core/internal/atomic.d">Improve this page</a>
+	<div class="tip smallprint">		<a href="https://github.com/dlang/druntime/edit/master/import/core/internal/atomic.d">Improve this page</a>

Upd: https://github.com/dlang/druntime/ repository has been archived on Oct 12, 2022. It is now read-only. So I think this links changes isn't matter

Upd2: Or matter? This generated html is used somewhere, albeit with a different base site name?

@dlang-bot
Copy link
Contributor

Thanks for your pull request and interest in making D better, @denizzzka! We are looking forward to reviewing it, and you should be hearing from a maintainer soon.
Please verify that your PR follows this checklist:

  • My PR is fully covered with tests (you can see the coverage diff by visiting the details link of the codecov check)
  • My PR is as minimal as possible (smaller, focused PRs are easier to review than big ones)
  • I have provided a detailed rationale explaining my changes
  • New or modified functions have Ddoc comments (with Params: and Returns:)

Please see CONTRIBUTING.md for more information.


If you have addressed all reviews or aren't sure how to proceed, don't hesitate to ping us with a simple comment.

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 + dmd#15880"

@denizzzka denizzzka changed the title druntime/posix.mak: Replace -Isrc by -Iimport [druntime docs generator] replaces -Isrc by -Iimport Dec 4, 2023
@denizzzka denizzzka marked this pull request as ready for review December 4, 2023 07:58
@denizzzka denizzzka changed the title [druntime docs generator] replaces -Isrc by -Iimport [druntime docs generator] replaces src/ by import/ Dec 4, 2023
@denizzzka denizzzka changed the title [druntime docs generator] replaces src/ by import/ [druntime docs generator] replaces src/* by import/* Dec 4, 2023
@denizzzka denizzzka changed the title [druntime docs generator] replaces src/* by import/* druntime docs generator: replaces src/* by import/* Dec 4, 2023
@denizzzka denizzzka changed the title druntime docs generator: replaces src/* by import/* Draft: druntime docs generator: replaces src/* by import/* Dec 5, 2023
@denizzzka denizzzka changed the title Draft: druntime docs generator: replaces src/* by import/* druntime docs generator: replaces src/* by import/* Dec 5, 2023
@denizzzka denizzzka changed the title druntime docs generator: replaces src/* by import/* Draft: druntime docs generator: replaces src/* by import/* Dec 5, 2023
@denizzzka denizzzka changed the title Draft: druntime docs generator: replaces src/* by import/* druntime docs generator: replaces src/* by import/* Dec 5, 2023
@RazvanN7 RazvanN7 merged commit 9244a46 into dlang:master Dec 13, 2023
43 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants