Skip to content

Fix sphinx build issues; add better travis fold reporting; update aut…#1448

Merged
tannewt merged 1 commit into
adafruit:masterfrom
dhalbert:sphinx-fixes
Jan 9, 2019
Merged

Fix sphinx build issues; add better travis fold reporting; update aut…#1448
tannewt merged 1 commit into
adafruit:masterfrom
dhalbert:sphinx-fixes

Conversation

@dhalbert
Copy link
Copy Markdown
Collaborator

@dhalbert dhalbert commented Jan 9, 2019

  • recommonmark updated versions a day ago, which made it stop working with the older version of sphinx (Sphinx<1.8.0) we were specifying in .travis.yml. This removes the version restrictions, and reworks some internal links in ports/nrf/README.md that were the only things that were failing with the newer versions.

I tried various features of recommonmark including AutoStructify, but was unable to get these links to work. These links were already broken in RTD anyway (they pointed to the README.md instead of the generated README.html).

  • Added a simple idiom and printing script to allow commands inside folds to save their status and then print it out after the fold.

  • Removed MicroPython-specific authors from author lists in conf.py to avoid confusion about who is responsible for CircuitPython documentaiton.

@dhalbert dhalbert requested a review from tannewt January 9, 2019 21:39
Copy link
Copy Markdown
Member

@tannewt tannewt left a comment

Choose a reason for hiding this comment

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

Thank you! Will merge once it passes.

@tannewt tannewt merged commit dabb8ff into adafruit:master Jan 9, 2019
@dhalbert dhalbert deleted the sphinx-fixes branch January 9, 2019 22:08
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.

2 participants