Skip to content

Fix all warnings in sphinx docs - #7094

Merged
sbc100 merged 1 commit into
incomingfrom
doc_warnings
Sep 5, 2018
Merged

Fix all warnings in sphinx docs#7094
sbc100 merged 1 commit into
incomingfrom
doc_warnings

Conversation

@sbc100

@sbc100 sbc100 commented Sep 4, 2018

Copy link
Copy Markdown
Collaborator
  • There were quiet a few dangling references
  • Don't default the language to cpp, since we have many JS example we want the
    autodetection feature of the default
  • Add -W to the docs build to keep them out for good.
  • Build docs in circleci
  • Use a fixed sphinx version by using pip install==1.7.8
  • Remove trailing whitespace and tabs from several files
    (Will followup with another cleanup for the rest)

@sbc100
sbc100 requested a review from kripken September 4, 2018 02:44

@kripken kripken left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Good idea!

lgtm aside from the issues in the 2 comments

@@ -1,633 +0,0 @@

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

we actually use this file to render emcc --help

// POLICIES
////////////////////////////////////////////////////////////////////////////////

template<int Index>

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

removal of arg and ret_val look unrelated? (arg does look unused, but not ret_val.)

Also add `-W` to the docs build to keep them out for good.

Also, build docs in circleci
@sbc100
sbc100 merged commit 906e14e into incoming Sep 5, 2018
@sbc100
sbc100 deleted the doc_warnings branch September 5, 2018 02:06
sbc100 added a commit that referenced this pull request Jul 7, 2026
The `webgl_context` link target was originally added in #7094 and used
by `WebGL context`_, but subsequent updates reverted back to using
inline URLs, leaving this link target definition unused.
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