Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Document - sphinx

See original GitHub issue


  • configure sphinx documentation with autodoc and apidoc
  • modify theme
  • configure autodoc to list all cqparts.params.Parameter classes (recursive) (perhaps modify docstring if applicable) List all cqparts.params.Parameter as valid constructor parameters. This could be tricky, and messy

#25 to deal with publishing.

Issue Analytics

  • State:closed
  • Created 6 years ago
  • Comments:21 (11 by maintainers)

github_iconTop GitHub Comments

jmwrightcommented, Nov 15, 2017

@fragmuffin I and @dcowden use docs embedded with the repo that are pushed to GitHub pages. The CadQuery library uses Sphinx, but I’ve very recently let GitHub push the docs out using its standard method with Jekyll.

Sphinx method with CadQuery:

Here’s the path I went down with embedded docs and Jekyll.

One nice thing about having your docs embedded with your repo is that you can manage them the same way as your code. Every time you push to master your docs are updated and pushed out to GitHub pages.

dcowdencommented, Oct 27, 2017

having created lots of models over the years, it would be great if we could arrange a way to re-orient models without forcing the designer to orient them correctly in the first place.
We have to expect that assemblies will be made from mixes of cq-created parts and external parts-- and its very cumbersome to force everyone to re-orient their models for positioning in the assembly.

What might be slick is to provide a way for model authors to create a mating coordinate system in terms of the corodinate systems already there in the model. This could be done using CQ, via STEP import even.

for example, perhaps I could do something like mates: { primary: defaultCsys.rotateX(180), secondary: faces(type=Cylinder).coordinateSystem() } Anyhow, the idea is three step process:

(1) create models, export to STEP or whatever if you want (2) create mates for each part, defined in terms of existing coordinate systems and/or geometrcy (3) link them together, either using mates or absolute positioning

Read more comments on GitHub >

github_iconTop Results From Across the Web

Welcome — Sphinx documentation
Sphinx makes it easy to create intelligent and beautiful documentation. Here are some of Sphinx's major features: Output formats: HTML (including Windows ...
Read more >
Getting Started with Sphinx - Read the Docs
Sphinx is a powerful documentation generator that has many great features for writing technical documentation including: Generate web pages, printable PDFs, ...
Read more >
Documenting Your Project Using Sphinx -
Documenting Your Project Using Sphinx¶. This covers just a few of the many many commands available via sphinx. For more, visit
Read more >
Documenting Python code with Sphinx - Towards Data Science
In simplest terms, the sphinx takes in your .rst files and converts them to HTML, and all that is done using just a...
Read more >
The Sphinx documentation generator - GitHub
The Sphinx documentation generator. Contribute to sphinx-doc/sphinx development by creating an account on GitHub.
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Post

No results found

github_iconTop Related Hashnode Post

No results found