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

All documentation has "_" as a prefix: This prevents typedocs from being served in gh-pages. #149

Closed
electricessence opened this Issue Oct 4, 2015 · 2 comments

Comments

Projects
None yet
3 participants
@electricessence

electricessence commented Oct 4, 2015

After removing the "_" in front of all my documentation files, gh-pages worked.

@sebastian-lenz

This comment has been minimized.

Show comment
Hide comment
@sebastian-lenz

sebastian-lenz Oct 7, 2015

Member

I've noted that too, but this a specific behaviour of GitHub pages and can be easily fixed by including a .nojekyll file at the document root. Documentation on this can be found here.

The underscores are created by the url builder when hitting external modules. There are issues describing better solutions and it should be gone in v0.4.

Member

sebastian-lenz commented Oct 7, 2015

I've noted that too, but this a specific behaviour of GitHub pages and can be easily fixed by including a .nojekyll file at the document root. Documentation on this can be found here.

The underscores are created by the url builder when hitting external modules. There are issues describing better solutions and it should be gone in v0.4.

@vsund

This comment has been minimized.

Show comment
Hide comment
@vsund

vsund Apr 23, 2018

Just to add this here for history: It's also possible to use Jekyll alongside generated code documentation.

I use a _config.yml with

include:
  - "_*_.html"
  - "_*_.*.html"

to get the generated files into GitHub Pages.


See here for an example.

vsund commented Apr 23, 2018

Just to add this here for history: It's also possible to use Jekyll alongside generated code documentation.

I use a _config.yml with

include:
  - "_*_.html"
  - "_*_.*.html"

to get the generated files into GitHub Pages.


See here for an example.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment