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

Fix myst cross-reference warnings. Also fix TOC. #206

Open
espenhgn opened this issue Oct 17, 2023 · 1 comment
Open

Fix myst cross-reference warnings. Also fix TOC. #206

espenhgn opened this issue Oct 17, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation no-issue-activity

Comments

@espenhgn
Copy link
Contributor

** The documentation issue**
There are now some myst cross-reference issues between files occurring with the online docs build using sphinx:

cd sphinx-docs/source
make html
....
preparing documents... done
writing output... [100%] usecases/saige_demo                                                                                                                                                  
/Users/espehage/Repositories/containers/docs/README.md:9: WARNING: 'myst' cross-reference target not found: './specifications/README.md' [myst.xref_missing]
/Users/espehage/Repositories/containers/docker/README.md:7: WARNING: 'myst' cross-reference target not found: './../docs/singularity/hello.md' [myst.xref_missing]
/Users/espehage/Repositories/containers/docker/README.md:9: WARNING: 'myst' cross-reference target not found: './../CONTRIBUTING.md' [myst.xref_missing]
/Users/espehage/Repositories/containers/docker/README.md:11: WARNING: 'myst' cross-reference target not found: './../usecases/gwas_demo.md' [myst.xref_missing]
/Users/espehage/Repositories/containers/docker/README.md:15: WARNING: 'myst' cross-reference target not found: './../usecases/README.md' [myst.xref_missing]
/Users/espehage/Repositories/containers/docker/README.md:28: WARNING: 'myst' cross-reference target not found: './../docs/singularity/README.md' [myst.xref_missing]
/Users/espehage/Repositories/containers/docker/README.md:32: WARNING: 'myst' cross-reference target not found: './../README.md' [myst.xref_missing]
/Users/espehage/Repositories/containers/scripts/README.md:5: WARNING: 'myst' cross-reference target not found: './gwas/README.md' [myst.xref_missing]
/Users/espehage/Repositories/containers/scripts/README.md:6: WARNING: 'myst' cross-reference target not found: './pgs/README.md' [myst.xref_missing]
/Users/espehage/Repositories/containers/usecases/README.md:5: WARNING: 'myst' cross-reference target not found: './gwas_demo.md' [myst.xref_missing]
/Users/espehage/Repositories/containers/usecases/README.md:5: WARNING: 'myst' cross-reference target not found: './../docs/specifications/README.md' [myst.xref_missing]
/Users/espehage/Repositories/containers/usecases/README.md:6: WARNING: 'myst' cross-reference target not found: './gwas_real.md' [myst.xref_missing]
/Users/espehage/Repositories/containers/usecases/README.md:7: WARNING: 'myst' cross-reference target not found: './meta_simu.md' [myst.xref_missing]
/Users/espehage/Repositories/containers/usecases/README.md:8: WARNING: 'myst' cross-reference target not found: './bolt-lmm_demo.md' [myst.xref_missing]
/Users/espehage/Repositories/containers/usecases/README.md:9: WARNING: 'myst' cross-reference target not found: './saige_demo.md' [myst.xref_missing]
/Users/espehage/Repositories/containers/usecases/README.md:10: WARNING: 'myst' cross-reference target not found: './../scripts/pgs/LDpred2/README.md' [myst.xref_missing]
generating indices... genindex done
writing additional pages... search done
...

Adding a proper hierarchy for the table of contents would be good.

@espenhgn espenhgn added the documentation Improvements or additions to documentation label Oct 17, 2023
Copy link

This issue appears to be stale due to non-activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation no-issue-activity
Projects
None yet
Development

No branches or pull requests

1 participant