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

Additional Documenter updates #25623

Merged
merged 2 commits into from
Jan 18, 2018
Merged

Conversation

mortenpi
Copy link
Contributor

This follows up on #25617 with some non-critical changes.

  • Enables canonical links elements for the doc builds which point to "stable" docs.
  • Cleans up the build directory before building another set of docs. Currently we actually deploy two HTML files to gh-pages for each .md page (e.g. base/file/index.html and base/file.html). This, I believe, is because during the build phase the docs also get built (with the "local" settings) and the doc/_build/ directory does not get cleaned up when make -C doc deploy gets called at the end of the build.

The html_canonical option will include <link> tags in the generated HTML
pages, pointing to the "stable" docs. This should hopefully be helpful
to the search engines.
Currently non-deploy docs, built with the pretty_urls option disabled,
also get pushed to gh-pages. With this, they will be cleaned away before
the deploy docs are built and we should end up with a single set of HTML
pages on the gh-pages branch (as opposed to the current e.g.
base/file.html AND base/file/index.html).
@JeffBezanson JeffBezanson merged commit 0379a38 into JuliaLang:master Jan 18, 2018
@mortenpi mortenpi deleted the doc-build-updates branch January 19, 2018 00:07
mortenpi added a commit to mortenpi/julia that referenced this pull request May 23, 2018
* Bump Documenter and deps.
* Canonical URLs and build cleanup. (JuliaLang#25623)
* Hide "The Julia Language" in navbar. (JuliaLang#27146)
ararslan pushed a commit that referenced this pull request May 23, 2018
* Bump Documenter and deps.
* Canonical URLs and build cleanup. (#25623)
* Hide "The Julia Language" in navbar. (#27146)
ararslan pushed a commit that referenced this pull request May 27, 2018
* Bump Documenter and deps.
* Canonical URLs and build cleanup. (#25623)
* Hide "The Julia Language" in navbar. (#27146)
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.

None yet

2 participants