Generating output docs #847
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- titles and headings - referencing methods
# Conflicts: # cmd2/ansi.py
# Conflicts: # docs/features/generating_output.rst # docs/features/settings.rst
We will not try and have Sphnix extract attribute documentation from the source code, it will just live in the documentation.
Codecov Report
@@ Coverage Diff @@
## master #847 +/- ##
==========================================
+ Coverage 97.21% 97.36% +0.14%
==========================================
Files 14 14
Lines 3519 3561 +42
==========================================
+ Hits 3421 3467 +46
+ Misses 98 94 -4
Continue to review full report at Codecov.
|
Member
|
When I try to build the docs on this branch on my machine, I get the following traceback: Traceback (most recent call last):
File "/Users/toddleonhardt/src/cmd2/.venv/lib/python3.7/site-packages/sphinx/cmd/build.py", line 276, in build_main
app.build(args.force_all, filenames)
File "/Users/toddleonhardt/src/cmd2/.venv/lib/python3.7/site-packages/sphinx/application.py", line 353, in build
self.builder.build_update()
File "/Users/toddleonhardt/src/cmd2/.venv/lib/python3.7/site-packages/sphinx/builders/__init__.py", line 299, in build_update
len(to_build))
File "/Users/toddleonhardt/src/cmd2/.venv/lib/python3.7/site-packages/sphinx/builders/__init__.py", line 361, in build
self.write(docnames, list(updated_docnames), method)
File "/Users/toddleonhardt/src/cmd2/.venv/lib/python3.7/site-packages/sphinx/builders/__init__.py", line 535, in write
self._write_serial(sorted(docnames))
File "/Users/toddleonhardt/src/cmd2/.venv/lib/python3.7/site-packages/sphinx/builders/__init__.py", line 545, in _write_serial
self.write_doc(docname, doctree)
File "/usr/local/Cellar/python/3.7.6_1/Frameworks/Python.framework/Versions/3.7/lib/python3.7/contextlib.py", line 119, in __exit__
next(self.gen)
File "/Users/toddleonhardt/src/cmd2/.venv/lib/python3.7/site-packages/sphinx/util/logging.py", line 219, in pending_warnings
memhandler.flushTo(logger)
File "/Users/toddleonhardt/src/cmd2/.venv/lib/python3.7/site-packages/sphinx/util/logging.py", line 184, in flushTo
logger.handle(record)
File "/usr/local/Cellar/python/3.7.6_1/Frameworks/Python.framework/Versions/3.7/lib/python3.7/logging/__init__.py", line 1524, in handle
self.callHandlers(record)
File "/usr/local/Cellar/python/3.7.6_1/Frameworks/Python.framework/Versions/3.7/lib/python3.7/logging/__init__.py", line 1586, in callHandlers
hdlr.handle(record)
File "/usr/local/Cellar/python/3.7.6_1/Frameworks/Python.framework/Versions/3.7/lib/python3.7/logging/__init__.py", line 890, in handle
rv = self.filter(record)
File "/usr/local/Cellar/python/3.7.6_1/Frameworks/Python.framework/Versions/3.7/lib/python3.7/logging/__init__.py", line 751, in filter
result = f.filter(record)
File "/Users/toddleonhardt/src/cmd2/.venv/lib/python3.7/site-packages/sphinx/util/logging.py", line 404, in filter
raise SphinxWarning(location + ":" + message)
sphinx.errors.SphinxWarning: /Users/toddleonhardt/src/cmd2/docs/features/generating_output.rst:32:py:mod reference target not found: cmd2.Cmd
Warning, treated as error:
/Users/toddleonhardt/src/cmd2/docs/features/generating_output.rst:32:py:mod reference target not found: cmd2.Cmd |
Member
|
I confirmed that I get the same traceback as above on a 2nd machine - both are macOS, but one has Python installed from |
tleonhardt
previously approved these changes
Jan 16, 2020
Member
Author
|
Sorry for the sloppy PR, that's kinda lame on my part 😬😞. Fixed. |
tleonhardt
previously approved these changes
Jan 16, 2020
kmvanbrunt
approved these changes
Jan 16, 2020
tleonhardt
approved these changes
Jan 16, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Some more documentation focused on generating output for #765.