search

lark-parser / lark

Lark is a parsing toolkit for Python, built with a focus on ergonomics, performance and modularity.
MIT License
4.87k stars 413 forks source link

0.11.3: sphinx warnings #903

Closed kloczek closed 2 years ago

kloczek commented 3 years ago 

[tkloczko@barrel lark-0.11.3]$ /usr/bin/python3 setup.py build_sphinx -b man
running build_sphinx
Running Sphinx v4.0.2
making output directory... done
generating gallery...
Using Sphinx-Gallery to convert rst text blocks to markdown for .ipynb files.
generating gallery for examples... [100%] json_parser.py
generating gallery for examples/advanced... [100%] qscintilla_json.py
computation time summary:
    - ../examples/advanced/_json_parser.py:              0.00 sec   0.0 MB
    - ../examples/advanced/conf_earley.py:               0.00 sec   0.0 MB
    - ../examples/advanced/conf_lalr.py:                 0.00 sec   0.0 MB
    - ../examples/advanced/create_ast.py:                0.00 sec   0.0 MB
    - ../examples/advanced/custom_lexer.py:              0.00 sec   0.0 MB
    - ../examples/advanced/error_handling.py:            0.00 sec   0.0 MB
    - ../examples/advanced/error_reporting_earley.py:    0.00 sec   0.0 MB
    - ../examples/advanced/error_reporting_lalr.py:      0.00 sec   0.0 MB
    - ../examples/advanced/extend_python.py:             0.00 sec   0.0 MB
    - ../examples/advanced/prioritizer.py:               0.00 sec   0.0 MB
    - ../examples/advanced/python_bytecode.py:           0.00 sec   0.0 MB
    - ../examples/advanced/python_parser.py:             0.00 sec   0.0 MB
    - ../examples/advanced/qscintilla_json.py:           0.00 sec   0.0 MB
    - ../examples/advanced/reconstruct_json.py:          0.00 sec   0.0 MB
    - ../examples/advanced/reconstruct_python.py:        0.00 sec   0.0 MB
    - ../examples/advanced/templates.py:                 0.00 sec   0.0 MB
    - ../examples/advanced/tree_forest_transformer.py:   0.00 sec   0.0 MB
    - ../examples/calc.py:                               0.00 sec   0.0 MB
    - ../examples/fruitflies.py:                         0.00 sec   0.0 MB
    - ../examples/indented_tree.py:                      0.00 sec   0.0 MB
    - ../examples/json_parser.py:                        0.00 sec   0.0 MB
    - ../examples/lark_grammar.py:                       0.00 sec   0.0 MB
    - ../examples/turtle_dsl.py:                         0.00 sec   0.0 MB
building [mo]: targets for 0 po files that are out of date
building [man]: all manpages
updating environment: [new config] 38 added, 0 changed, 0 removed
/usr/lib/python3.8/site-packages/recommonmark/parser.py:75: UserWarning: Container node skipped: type=document
  warn("Container node skipped: type={0}".format(mdnode.t))
/usr/lib/python3.8/site-packages/recommonmark/parser.py:75: UserWarning: Container node skipped: type=document
  warn("Container node skipped: type={0}".format(mdnode.t))
reading sources... [100%] visitors
/home/tkloczko/rpmbuild/BUILD/lark-0.11.3/lark/lark.py:docstring of lark.lark.Lark:81: WARNING: Definition list ends without a blank line; unexpected unindent.
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... lark.7 { philosophy features parsers json_tutorial how_to_use how_to_develop recipes examples/index examples/indented_tree examples/fruitflies examples/lark_grammar examples/calc examples/turtle_dsl examples/json_parser examples/advanced/conf_lalr examples/advanced/templates examples/advanced/conf_earley examples/advanced/error_handling examples/advanced/extend_python examples/advanced/reconstruct_json examples/advanced/custom_lexer examples/advanced/tree_forest_transformer examples/advanced/_json_parser examples/advanced/prioritizer examples/advanced/reconstruct_python examples/advanced/python_bytecode examples/advanced/create_ast examples/advanced/error_reporting_earley examples/advanced/error_reporting_lalr examples/advanced/python_parser examples/advanced/qscintilla_json grammar tree_construction classes visitors forest tools } /home/tkloczko/rpmbuild/BUILD/lark-0.11.3/docs/json_tutorial.md:492: WARNING: None:any reference target not found: examples
/home/tkloczko/rpmbuild/BUILD/lark-0.11.3/docs/how_to_use.md:83: WARNING: None:any reference target not found: nearley
/home/tkloczko/rpmbuild/BUILD/lark-0.11.3/docs/examples/index.rst:430: WARNING: Failed to create a cross reference. A title or caption not found: sphx_glr_examples_advanced_create_ast.py
done
build succeeded, 4 warnings.

The manual pages are in build/sphinx/man.

Sphinx-Gallery successfully executed 0 out of 0 files subselected by:

    gallery_conf["filename_pattern"] = '/plot'
    gallery_conf["ignore_pattern"]   = '__init__\\.py'

after excluding 0 files that had previously been run (based on MD5).
erezsh commented 3 years ago

Thanks for letting us know.

I don't know that it's possible to completely get rid of the warnings.

But I have pushed some changes that should fix some of them.

erezsh commented 3 years ago

P.S. the warning for nearley should disappear if you run git submodule update --init.