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

Add more docs for FE, Link to BE docs #90

Merged
merged 6 commits into from
Sep 21, 2023
Merged

Add more docs for FE, Link to BE docs #90

merged 6 commits into from
Sep 21, 2023

Conversation

chubetho
Copy link
Collaborator

@chubetho chubetho commented Sep 17, 2023

Notes: Backend docs is now linked but not reliable

Run npm run docs to see result

@chubetho chubetho self-assigned this Sep 17, 2023
@@ -28,7 +28,7 @@ jobs:
run: |
python -m pip install --upgrade pip setuptools wheel
pip install -r requirements.txt
npm ci
npm ci --force
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Because tsdoc to markdown package is currently not support TS > 5.0

Copy link
Owner

Choose a reason for hiding this comment

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

this same error is also thrown when running npm install on the repo atm - i don't think making users always use npm install --force is a good idea (or good practice)

@chubetho chubetho requested review from 4lex0017 and twynb September 17, 2023 22:16
@twynb
Copy link
Owner

twynb commented Sep 19, 2023

attempting to run npm run docs crashes for me, with the error no such file or directory, open {path\to\repo}\AudioStreamSplitting\docs\frontend\composables\useConvertSecToMin.md. I'm assuming this is a config issue where no docs for composables/other components are generated, but looking at the vitepress config it seems to try to load those docs.

@chubetho
Copy link
Collaborator Author

attempting to run npm run docs crashes for me, with the error no such file or directory, open {path\to\repo}\AudioStreamSplitting\docs\frontend\composables\useConvertSecToMin.md. I'm assuming this is a config issue where no docs for composables/other components are generated, but looking at the vitepress config it seems to try to load those docs.

Remove tsdoc2markdown now because it does not support ts>5.0 at the moment.
I will find another alternative package or write one later.

Copy link
Owner

@twynb twynb left a comment

Choose a reason for hiding this comment

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

The backend docs issue i think should be fixed in a separate ticket (hence me paging alex).

Please fix the composables issue before merging.

nav: [
{
text: 'Backend',
link: '/backend/_build/markdown/',
Copy link
Owner

Choose a reason for hiding this comment

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

this links to the index, but links from the index onwards don't seem to work. i tried renaming one of the backend markdown files so the file name doesn't contain any "."s, which fixed the issue - @4lex0017 is it possible for sphinx to have a different separating character rather than "." for module namespacing? (like "backend-modules-api_service.md" rather than "backend.modules.api-service.md")

Copy link
Collaborator

Choose a reason for hiding this comment

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

Nope it is not possible

Copy link
Collaborator

Choose a reason for hiding this comment

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

Unless we wirite a script to do it

src/frontend/docgen.config.js Show resolved Hide resolved
@chubetho chubetho merged commit 2052e76 into main Sep 21, 2023
1 check passed
@chubetho chubetho deleted the docs branch September 21, 2023 18:35
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