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

Windows installation via conda-forge #185

Merged
merged 16 commits into from
Jan 21, 2021
Merged

Conversation

mabelzhang
Copy link
Contributor

@mabelzhang mabelzhang commented Dec 23, 2020

Partially addresses gazebosim/docs#117

See explanation about why it needs to refer to ign-cmake here gazebosim/gz-cmake#139

@github-actions github-actions bot added 🏢 edifice Ignition Edifice 🏰 citadel Ignition Citadel 📜 blueprint Ignition Blueprint 🔮 dome Ignition Dome labels Dec 23, 2020
Signed-off-by: Mabel Zhang <[email protected]>
@codecov
Copy link

codecov bot commented Dec 23, 2020

Codecov Report

Merging #185 (b19019e) into ign-math6 (bb60be4) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           ign-math6     #185   +/-   ##
==========================================
  Coverage      99.20%   99.20%           
==========================================
  Files             63       63           
  Lines           6020     6020           
==========================================
  Hits            5972     5972           
  Misses            48       48           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update bb60be4...b19019e. Read the comment docs.

@chapulina chapulina added the Windows Windows support label Dec 23, 2020
@mabelzhang
Copy link
Contributor Author

Updated tutorial so that dependencies are installed via conda-forge releases, and building is via cmake.

Signed-off-by: Mabel Zhang <[email protected]>
Signed-off-by: Mabel Zhang <[email protected]>
Copy link

@JShep1 JShep1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Small nit but other than that looks good

tutorials/installation.md Outdated Show resolved Hide resolved
@mabelzhang
Copy link
Contributor Author

mabelzhang commented Jan 8, 2021

I noticed the rendering of the currently deployed tutorial webpage looks wrong from Prerequisites section downward: https://ignitionrobotics.org/api/math/6.8/install.html

I'm not sure what's off, the indentation of the code block under a bullet, or the empty line before it.

The ign-physics tutorial looks correct though: https://ignitionrobotics.org/api/physics/3.1/installation.html
So I copied the format there (2 space indentation, no empty line) in f70097c. Hopefully when this is deployed, it'll look correct.
Noting for when you make the tutorial template @JShep1

@chapulina
Copy link
Contributor

I noticed the rendering of the currently deployed tutorial webpage looks wrong

I suggest debugging locally using make doc and loading the documentation on build/doxygen/html/index.html

@mabelzhang
Copy link
Contributor Author

mabelzhang commented Jan 8, 2021

Cool thanks for the tip! All the code blocks look correct for me locally now.

Definitely needs 2-space indentation instead of 4 for the code block to render correctly under a bullet, and no empty line before the code block. Doxygen interprets empty lines within an item as the end of the bullet list, unlike GitHub.

Signed-off-by: Mabel Zhang <[email protected]>
Signed-off-by: Mabel Zhang <[email protected]>
Signed-off-by: John Shepherd <[email protected]>
Signed-off-by: John Shepherd <[email protected]>
@JShep1 JShep1 merged commit e96ce59 into ign-math6 Jan 21, 2021
@JShep1 JShep1 deleted the mabelzhang/windows_install branch January 21, 2021 01:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📜 blueprint Ignition Blueprint 🏰 citadel Ignition Citadel 🔮 dome Ignition Dome 🏢 edifice Ignition Edifice Windows Windows support
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants