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

Building Sphinx documentation with MyST on Windows #30

Open
ESKYoung opened this issue Jun 14, 2021 · 1 comment
Open

Building Sphinx documentation with MyST on Windows #30

ESKYoung opened this issue Jun 14, 2021 · 1 comment
Labels
bug Something isn't working help wanted Extra attention is needed

Comments

@ESKYoung
Copy link
Collaborator

Including files from outside the docs folder with MyST is useful to prevent de-duplication of documentation throughout the project.

However, during Windows builds, this throws a warning message that is not present when building documentation on Unix machines. Worth investigating to fix, but currently the GitHub Actions build for Windows does not enforce warnings as errors, but the Unix one does.

@Jacobb164
Copy link
Collaborator

These warning messages come from internal links not building correctly on windows created docs. I'm looking into this next.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants