Skip to content

docs: use vitepress config for markdown pre-renderer #835

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

Merged
merged 1 commit into from
Apr 13, 2022

Conversation

ST-DDT
Copy link
Member

@ST-DDT ST-DDT commented Apr 12, 2022

The api-pages.ts file is required during both the docs building and now api docs generation.
(Unfortunately, there is a circular dependency in there api-pages -> vitepress config -> markdown renderer -> api-docs generator -> api-pages, but that shouldn't be an issue, because the generator is indepent of the file's content)

We can either create it with dummy data if it is missing or just add it to the repo.

Adding the file to the repo has the added benefit, of making it easier to detect, if the docs generation does no longer generate all the modules.

@ST-DDT ST-DDT added c: docs Improvements or additions to documentation p: 1-normal Nothing urgent labels Apr 12, 2022
@ST-DDT ST-DDT added this to the v6.2 - New small features milestone Apr 12, 2022
@ST-DDT ST-DDT requested a review from a team April 12, 2022 18:50
@ST-DDT ST-DDT self-assigned this Apr 12, 2022
@ST-DDT ST-DDT requested a review from a team April 12, 2022 18:50
@ST-DDT ST-DDT requested a review from a team as a code owner April 12, 2022 18:50
@codecov
Copy link

codecov bot commented Apr 12, 2022

Codecov Report

Merging #835 (c8937f3) into main (bb2dfb6) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #835   +/-   ##
=======================================
  Coverage   99.34%   99.34%           
=======================================
  Files        1921     1921           
  Lines      179170   179170           
  Branches      895      895           
=======================================
  Hits       177993   177993           
  Misses       1121     1121           
  Partials       56       56           

@ST-DDT ST-DDT requested a review from a team April 12, 2022 20:11
@ST-DDT ST-DDT merged commit 360bec7 into main Apr 13, 2022
@ST-DDT ST-DDT deleted the docs/use-vitepress-config branch April 13, 2022 08:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: docs Improvements or additions to documentation p: 1-normal Nothing urgent
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants