Skip to content
This repository has been archived by the owner on Mar 25, 2022. It is now read-only.

parser: multiple warning messages due to missing visit_document() method #177

Closed
drrosa opened this issue Oct 3, 2019 · 5 comments
Closed

parser: multiple warning messages due to missing visit_document() method #177

drrosa opened this issue Oct 3, 2019 · 5 comments

Comments

@drrosa
Copy link

drrosa commented Oct 3, 2019

We are seeing a lot of warnings like the following for every .md document:
.../python3.6/site-packages/recommonmark/parser.py:75: UserWarning: Container node skipped: type=document

It looks like def default_depart(self, mdnode) generates a warning for every container node of type document because the method visit_document does not exist?

PR #106 addresses part of this issue by providing useful debug info, but the warnings are still getting generated.
This was referenced Oct 3, 2019
Closed
Closed
@jpmckinney
Copy link

jpmckinney commented Nov 19, 2019 •
edited
Loading

I'm using Sphinx programmatically, so I created a subclass:

class CustomCommonMarkParser(CommonMarkParser):
    def visit_document(self, node):
        pass

and then later (I need to not add 'recommonmark' to the extensions config):

app.add_source_suffix('.md', 'markdown')
app.add_source_parser(CustomCommonMarkParser)

@jacobtomlinson jacobtomlinson mentioned this issue Nov 24, 2019
Closed
drrosa added a commit to drrosa/zulip that referenced this issue Nov 30, 2019
@drrosa
docs: Remove build warning.
5de656c 
Temporary workaround to remove multiple
"UserWarning: Container node skipped: type=document"
caused by upstream bug readthedocs/recommonmark#177.

Addresses zulip#13263.
@drrosa
Copy link
Author

drrosa commented Nov 30, 2019

@jpmckinney Thanks for sharing a workaround to this issue!

@drrosa drrosa mentioned this issue Dec 2, 2019
Merged
timabbott pushed a commit to zulip/zulip that referenced this issue Dec 3, 2019
@drrosa @timabbott
docs: Remove build warning.
1596da9 
Temporary workaround to remove multiple
"UserWarning: Container node skipped: type=document"
caused by upstream bug readthedocs/recommonmark#177.

Addresses #13263.
blevenson pushed a commit to blevenson/zulip that referenced this issue Dec 8, 2019
@drrosa @blevenson
docs: Remove build warning.
09e3721 
Temporary workaround to remove multiple
"UserWarning: Container node skipped: type=document"
caused by upstream bug readthedocs/recommonmark#177.

Addresses zulip#13263.
bongjlee pushed a commit to bongjlee/zulip that referenced this issue Dec 9, 2019
@drrosa @bongjlee
docs: Remove build warning.
0018ae1 
Temporary workaround to remove multiple
"UserWarning: Container node skipped: type=document"
caused by upstream bug readthedocs/recommonmark#177.

Addresses zulip#13263.
YashRE42 pushed a commit to YashRE42/zulip that referenced this issue Dec 12, 2019
@drrosa
docs: Remove build warning.
4e23b5e 
Temporary workaround to remove multiple
"UserWarning: Container node skipped: type=document"
caused by upstream bug readthedocs/recommonmark#177.

Addresses zulip#13263.
YashRE42 pushed a commit to YashRE42/zulip that referenced this issue Dec 25, 2019
@drrosa
docs: Remove build warning.
1aea30c 
Temporary workaround to remove multiple
"UserWarning: Container node skipped: type=document"
caused by upstream bug readthedocs/recommonmark#177.

Addresses zulip#13263.
@abhilash1in
Copy link

I'm still seeing this warning with recommonmark 0.6.0

@joe7575
Copy link

joe7575 commented Sep 1, 2020 •
edited
Loading

I'm still seeing this warning with recommonmark 0.6.0

The same with me.

...\site-packages\recommonmark\parser.py:75: UserWarning: Container node skipped: type=document

rmatev added a commit to lhcb/starterkit-ci that referenced this issue Nov 3, 2020
@rmatev
Workaround for recommonmark warning
97192d8 
See readthedocs/recommonmark#177
@rmatev rmatev mentioned this issue Nov 3, 2020
Merged
@unkempthenry unkempthenry mentioned this issue Dec 9, 2020
Merged
@bmxp
Copy link

bmxp commented Jan 3, 2021

I still got the same warning in version 0.7.1.
@ericholscher Could you please add

    def visit_document(self, mdnode):
        pass

to parser.py or are there arguments against it?

ezra-en added a commit to BuildTheEarth/docs that referenced this issue Apr 12, 2021
@ezra-en
Trying workaround
d786059 
See readthedocs/recommonmark#177.
@ezra-en ezra-en mentioned this issue Apr 12, 2021
Closed
@dmalan dmalan mentioned this issue Apr 24, 2021
Closed
@simon-ritchie simon-ritchie mentioned this issue Jun 1, 2021
Closed
klihub added a commit to klihub/cri-resource-manager that referenced this issue Nov 17, 2021
@klihub
docs: fix recommonmark breaking doc build on github.
09cc1ee 
An unfixed upstream recommonmark bug causes warnings during
'make site-build'/sphinx doc generation. These warnings are
treated as errors in github actions, so they can break test
builds of recent PRs. Fix this by switching to MyST-Parser.

See readthedocs/recommonmark#177
for a miminal explanation of the bug.
See readthedocs/recommonmark#221
for background information on recommon
@klihub klihub mentioned this issue Nov 17, 2021
Merged
@marquiz marquiz mentioned this issue Feb 16, 2022
Merged
@stephen-smith stephen-smith mentioned this issue Apr 26, 2022
Closed
@seraphr seraphr mentioned this issue Oct 7, 2022
Merged
@github-actions github-actions bot mentioned this issue Apr 11, 2024
Merged
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
6 participants
@ericholscher @jpmckinney @drrosa @bmxp @abhilash1in @joe7575