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

[Docs] Update doc build system #769

Merged
merged 4 commits into from
Mar 7, 2022

Conversation

wangruohui
Copy link
Member

@wangruohui wangruohui commented Mar 2, 2022

The current doc build system modifies md files in place, which makes local development hard and faulty. This PR explicitly creates temporary files for intermediate md files.

Preview: https://mmediting--769.org.readthedocs.build/en/769/

A side effect is that autogenerated links will have "_tmp" in their paths.

@codecov
Copy link

codecov bot commented Mar 2, 2022

Codecov Report

Merging #769 (7d417fd) into master (2ab95c4) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #769   +/-   ##
=======================================
  Coverage   83.05%   83.05%           
=======================================
  Files         216      216           
  Lines       12192    12192           
  Branches     1964     1964           
=======================================
  Hits        10126    10126           
  Misses       1763     1763           
  Partials      303      303           
Flag Coverage Δ
unittests 83.01% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2ab95c4...7d417fd. Read the comment docs.

@wangruohui wangruohui requested a review from innerlee March 2, 2022 04:55
@wangruohui wangruohui changed the title [Docs] Update build system [Docs] Update doc build system Mar 7, 2022
@wangruohui wangruohui mentioned this pull request Mar 7, 2022
1 task
@wangruohui wangruohui merged commit 253cb27 into open-mmlab:master Mar 7, 2022
Yshuo-Li pushed a commit to Yshuo-Li/mmediting that referenced this pull request Jul 15, 2022
* stash

* cleanup

* use relpath for dataset.md and modelzoo.md

* basename for reference
Yshuo-Li pushed a commit to Yshuo-Li/mmediting that referenced this pull request Jul 15, 2022
* stash

* cleanup

* use relpath for dataset.md and modelzoo.md

* basename for reference
@zengyh1900 zengyh1900 linked an issue Oct 9, 2022 that may be closed by this pull request
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.

[Docs] Checklist for documentation upgrade
2 participants