mikepurvis / catkin_tools_document Goto Github PK
View Code? Open in Web Editor NEWExperimental parallel documentation plugin for catkin_tools
License: Apache License 2.0
catkin_tools_document's People
Contributors
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
Stargazers
Watchers
catkin_tools_document's Issues
"docs" space isn't deleted on `catkin clean`
Because documentation is a new verb rather than a new build type, I don't think this is fixable without an additional hook from catkin_tools. Basically, there would need to be a way to register a new "space" with catkin_tools. This would actually be great for a couple reasons:
- It would allow it to be tracked and cleaned properly, as in this ticket.
- It would make the new space a first-class member of the Context object, whereas right now the "docs space" is kind of goofily placed at
$build_space/../docs. - It would allow the user to explicitly set the location of the docs space, similar to how the other spaces can be set with
catkin config.
Thoughts on this, @wjwwood?
New release, now that pydoctor for py3 is out
See: twisted/pydoctor#96
Should bump to 0.3.0, add back the dependency with a version requirement, and add python_version>="3.5".
FYI @tspicer01
Populate source location in summary page
Currently it's just ?:
Two possibilities for where to get this information:
- Use the default remote from the directories in the workspace (only works if they're git repos and not, eg, tarballs).
- Using
ROSDISTRO_INDEX_URI, query the rosdistro source cache (only works if the source information is part of the cache).
Use pluggable spaces to define docs space
With catkin/catkin_tools#458 merged, this package should be changed to take advantage of it, specifically by registering the "docs" space with catkin_tools itself rather than using <build_space>/../docs as it presently does.
Blacklist/Whitelist has been renamed
Blacklist/whitelist has been renamed in release 0.8.3 (catkin/catkin_tools#712)
Traceback (most recent call last):
File "/usr/bin/catkin", line 33, in <module>
sys.exit(load_entry_point('catkin-tools==0.[8](https://github.com/tue-robotics/tue-robotics.github.io/runs/5407686727?check_suite_focus=true#step:4:8).3', 'console_scripts', 'catkin')())
File "/usr/lib/python3/dist-packages/catkin_tools/commands/catkin.py", line 266, in main
catkin_main(sysargs)
File "/usr/lib/python3/dist-packages/catkin_tools/commands/catkin.py", line 261, in catkin_main
sys.exit(args.main(args) or 0)
File "/home/amigo/.local/lib/python3.8/site-packages/catkin_tools_document/cli.py", line 32, in main
return document_workspace(
File "/home/amigo/.local/lib/python3.8/site-packages/catkin_tools_document/document.py", line 243, in document_workspace
[p for p in context.whitelist],
AttributeError: 'Context' object has no attribute 'whitelist'New release?
Could you please create a new release now the intersphinx_mapping feature has been merged?
Catkin document appears to crash on summary:summary_sphinx
I was trying to run catkin_document, but it appears to crash when sphinx wants to generate a summary.
I've tried to run with --no-summary as a workaround, but it produces the same error.
Do you have any idea how I can fix it?
$ catkin document
[build] Found '12' packages in 0.0 seconds.
Starting >>> package1
...
Starting >>> package12
Finished <<< package1 [ 0.0 seconds ]
...
Finished <<< package12 [ 1.2 seconds ]
Starting >>> summary
_______________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________
Errors << summary:summary_sphinx logs/summary/document.summary_sphinx.008.log
Exception occurred:
File "/usr/lib/python2.7/dist-packages/sphinx/util/parallel.py", line 99, in _join_one
raise SphinxParallelError(*result)
SphinxParallelError: InputError: [Errno 2] No such file or directory: u'/<directory>/docs/actionlib/CHANGELOG.rst'
The full traceback has been saved in /tmp/sphinx-err-Pupaeg.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!
cd /home/ishadijcks/march-iv/march_ws/build/docs; catkin document --get-env summary | catkin env -si /usr/bin/sphinx-build -j8 -E . /<directory>/march-iv/march_ws/build/../docs; cd -
...............................................................................................................................................................................................................................................................
Failed << summary:summary_sphinx [ Exited with code 1 ]
Failed <<< summary [ 0.5 seconds ]
[document] Summary: 12 of 13 packages succeeded.
[document] Ignored: None.
[document] Warnings: None.
[document] Abandoned: None.
[document] Failed: 1 packages failed.
[document] Runtime: 4.5 seconds total.
New release?
Could you create a new PyPi release?
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.