Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

pre-0.4.0 Documentation #318

Merged
merged 22 commits into from
Apr 14, 2016
Merged

pre-0.4.0 Documentation #318

merged 22 commits into from
Apr 14, 2016

Conversation

jbohren
Copy link
Contributor

@jbohren jbohren commented Apr 14, 2016

Rebased PR thanks to @wjwwood to supersede #250.

jbohren and others added 12 commits April 13, 2016 19:43
…local sphinx style, and reorganizing main index
- updated build type stages
- added scripts for recording examples
- added scripts for capturing CLI interfaces to txt files
- moved catkin tools history to specific history page
- simplified index
- updated build mechanics for new features
- added migration guide with troubleshooting based on observed use cases
- updated quick start with asciinemas
- updated build with asciinemas
- added env verb
- added example resources to installation
- regenerating examples and cli interfaces
- switching all text to sentence-per-line
- adding scripts and documentation for regenerating examples
- moving --locate-extra-shell-verbs to locate verb
- adding details on linked develspace
@jbohren
Copy link
Contributor Author

jbohren commented Apr 14, 2016

@wjwwood It looks like the enchant library is available on OS X for Python2 but not Python3. This might be a bug with PyEnchant 1.6.6: pyenchant/pyenchant#63

@jbohren jbohren force-pushed the pre-0.4.0-docs-rebase branch from b912cc4 to 8d54ee6 Compare April 14, 2016 04:04
@wjwwood
Copy link
Member

wjwwood commented Apr 14, 2016

Can you just conditionally import it in the conf.py?

@jbohren
Copy link
Contributor Author

jbohren commented Apr 14, 2016

Can you just conditionally import it in the conf.py?

Possibly, now that it's passing on all CI variants. I just wanted to do something fast to get it working.

@jbohren
Copy link
Contributor Author

jbohren commented Apr 14, 2016

@wjwwood d2809e8 drops the extra sphinx conf, and conditionally uses spelling based on the tag supplied with -t at the cli.

@jbohren
Copy link
Contributor Author

jbohren commented Apr 14, 2016

@wjwwood All checks passing.

@jbohren
Copy link
Contributor Author

jbohren commented Apr 14, 2016

@wjwwood
Copy link
Member

wjwwood commented Apr 14, 2016

While reviewing the documentation I noticed: #319

@wjwwood
Copy link
Member

wjwwood commented Apr 14, 2016

Pushed some commits.

@wjwwood
Copy link
Member

wjwwood commented Apr 14, 2016

I'm gonna merge this and we can fix up things in follow up PR's and issues.

Thanks @jbohren this is a really great improvement to the docs. 🎉

@wjwwood wjwwood merged commit efc54bd into master Apr 14, 2016
@wjwwood wjwwood deleted the pre-0.4.0-docs-rebase branch April 14, 2016 23:22
@wjwwood
Copy link
Member

wjwwood commented Apr 15, 2016

@jbohren looks like RTD is failing on master after merging this:

https://readthedocs.org/projects/catkin-tools/builds/3910003/

Something about duplicate entries of osrf-pycommon. Not sure what it is on about.

@wjwwood
Copy link
Member

wjwwood commented Apr 15, 2016

Sure enough it was in the requirement.txt file twice, I fixed it with abb17d7. Might have been a bad merge.

@dirk-thomas
Copy link
Contributor

Imo the "Migrating from catkin_make" pages suffers from the fact that it mixes two aspects. The step to move from catkin_make to an isolated build (like catkin_make_isolated) and then the step to catkin build. By better separating these two, their differences and similarities as well as their common problems I think a lot of previous (nd likely upcoming) questions could be avoided. Since basically users are not aware of the isolation aspect in the first place. I think a two-step migration would help users to first get their code working with catkin_make_isolated before reporting "issues" with catkin build.

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.

3 participants