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

Pinned doc deps #19538

Merged
merged 4 commits into from
Dec 10, 2016
Merged

Pinned doc deps #19538

merged 4 commits into from
Dec 10, 2016

Conversation

MichaelHatherly
Copy link
Member

As requested by @tkelman, pinned versions of documentation dependencies. Also reinstates the stacktraces stdlib file that had been left out of the index.

Also removes C.md and julia.md index files from devdocs since their
content is a duplicate of what is found in the nav menu.
Versions must be kept exact to allow for reproducible doc builds.
@MichaelHatherly MichaelHatherly added docs This change adds or pertains to documentation docsystem The documentation building system labels Dec 8, 2016
@@ -0,0 +1,3 @@
Compat 0.9.5 0.9.5+
DocStringExtensions 0.3.0 0.3.0+
Documenter 0.8.2 0.8.2+
Copy link
Member Author

Choose a reason for hiding this comment

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

@tkelman, I assume you did mean pinning all the dependencies rather than just Documenter?

Copy link
Contributor

Choose a reason for hiding this comment

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

right

Copy link
Contributor

@tkelman tkelman left a comment

Choose a reason for hiding this comment

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

their content is a duplicate of what is found in the nav menu.

How does that nav menu get populated with an index then?

@MichaelHatherly
Copy link
Member Author

How does that nav menu get populated with an index then?

Those two index pages contain the same set of page links as the two subsections in

julia/doc/make.jl

Lines 87 to 110 in 4dcada1

"Documentation of Julia's Internals" => [
"devdocs/init.md",
"devdocs/eval.md",
"devdocs/ast.md",
"devdocs/types.md",
"devdocs/object.md",
"devdocs/functions.md",
"devdocs/callconv.md",
"devdocs/cartesian.md",
"devdocs/meta.md",
"devdocs/subarrays.md",
"devdocs/sysimg.md",
"devdocs/llvm.md",
"devdocs/stdio.md",
"devdocs/boundscheck.md",
"devdocs/locks.md",
"devdocs/offset-arrays.md",
],
"Devloping/debugging Julia's C code" => [
"devdocs/backtraces.md",
"devdocs/debuggingtips.md",
"devdocs/valgrind.md",
"devdocs/sanitizers.md",
]
. (PAGES is what is used to build the nav menu.)

Automatic conversion of RST definition lists into markdown left quite
a bit of room for improvement. This reformats all fieldname lists to
use a single layout, namely:

    `fieldname`

    Description of `fieldname`...

Also fixes up some sublists that were not correctly rendered in the
RST docs originally.
@MichaelHatherly
Copy link
Member Author

MichaelHatherly commented Dec 9, 2016

Also includes fixes for #18588 (comment) and #18588 (comment).

The last commit reformats devdocs/ast.md quite a bit to get a more consistent layout, which I think is more readable.

@tkelman tkelman merged commit 0dfadd0 into JuliaLang:master Dec 10, 2016
@MichaelHatherly MichaelHatherly deleted the mh/doc-fixes-2 branch December 11, 2016 07:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation docsystem The documentation building system
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants