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.

Documentation tied to version of compas pkg.

See original GitHub issue

Issue Description

Documentation tied to version of compas pkg.

Problem description

I’d guess that the majority of users are installing compas from pypi or conda which means that they are installing the repo at a tagged commit. If they want to view the documentation online however they will see documentation from the most recent commit, which could cause confusion.

So the correct (version specific) documentation will be available in the installed package but not online.

Proposed solution

I think it would be good to consider a system that allows documentation tied to tagged commits.

Two examples with both works with Sphinx would be:

Sphinxcontrib-versioning could probably work with our current Invoke solution while a solution like ReadTheDocs would mean having the docs built and hosted by another service.

If there’s interest I’d happily help making this change.

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:13 (13 by maintainers)

github_iconTop GitHub Comments

tetovcommented, Oct 1, 2019

pasting here from a parallel discussion:

the “problem” is indeed related to this. however, in the specific case of delaunay and trimesh, the api docs do correspond to the current conda package version (0.7.2) but the examples and tutorials reflect an older state. not sure how these get generated…

context: we encountered in the MAS compas introduction, that the example mesh-delaunay-from-points and mesh-remeshing both import from compas.topology intsead of compas.geometry and compas.datastructures respectively.

I’m currently updating the examples (docs/examples/) to make them work with v0.7.2. I’m not sure the examples as they are set up now could be tied to versions… I’ll have a look.

yck011522commented, Sep 23, 2020

Generic Ping.

I see that compas_fab have this versioning already. I don’t know the implementation details but maybe we can use the same system?

Maybe @gonzalocasas have some experience?

Read more comments on GitHub >

github_iconTop Results From Across the Web

version - Go Packages
When a project reaches major version v1 it is considered stable. Learn more. Repository. Links. Report a Vulnerability ...
Read more >
compass python package — compass latest documentation
The proposed solution would be to write test cases as Python packages made up of modules, functions and classes within a larger compass...
Read more >
HCL Compass v2.0.3 release notes - HCL support
Release notes for HCL Compass v2.0.3. The attached release notes contain the information that you need to get started with HCL Compass v2.0.3....
Read more >
Reference Documentation - Compass
Compass is a powerful, transactional Java Search Engine framework. Compass allows you to declaratively map your Object domain model to the underlying Search ......
Read more >
compass/ at main - GitHub
NOTE: During the installation of Compass, the installed Kyma version (as a basis ... custom domain TLS certificate document in the Kyma installation...
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