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 docs #755

merged 6 commits into from Feb 27, 2018


None yet
3 participants

ppannuto commented Feb 26, 2018

Pull Request Overview

Our docs haven't been building for a little while (likely since the last nightly bump). This fixes their invocation so they build again.

Testing Strategy

Building docs locally.

Documentation Updated / Formatting


ppannuto added some commits Feb 26, 2018

tools: fix doc building
Need to ensure rustup toolchain is set correctly and that rustdoc
is given an absolute path for things to work now

@ppannuto ppannuto added the P-Upkeep label Feb 26, 2018

@ppannuto ppannuto referenced this pull request Feb 26, 2018


rustdoc deprecations #756

ppannuto and others added some commits Feb 27, 2018

tools: $(TMPDIR) -> mktemp
Apparently not all Make's have $(TMPDIR)
rustdoc: fix deprecation warning
We were doing tricks with the rustdoc arguments to allow us to document
private fields, but now there is just a flag for it.
docs: fix many warnings for rustdoc
rustdoc changed which markdown parser it is using. It now throws a
warning if your docs will look different. Essentially this commit fixes
our docs so they will look "right" by changing them to what they should
have been before.

alevy approved these changes Feb 27, 2018

@ppannuto ppannuto merged commit f758a18 into master Feb 27, 2018

3 checks passed

continuous-integration/travis-ci/pr The Travis CI build passed
continuous-integration/travis-ci/push The Travis CI build passed
deploy/netlify Deploy preview ready!

@ppannuto ppannuto deleted the fix-docs branch Feb 27, 2018

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