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.

Sign up for GitHub

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

Jump to bottom

Documentation of factors #30

Open
yetongatech opened this issue May 30, 2019 · 2 comments
Open

Documentation of factors #30

yetongatech opened this issue May 30, 2019 · 2 comments
Assignees
@dellaert
Labels
enhancement Improvement to GTSAM question More of a question rather than an issue

Comments

@yetongatech
Copy link
Contributor

May I know if there is a documentation of all the factors? @dellaert
@dellaert dellaert self-assigned this May 30, 2019
@dellaert dellaert added enhancement Improvement to GTSAM question More of a question rather than an issue labels May 30, 2019
@dellaert
Copy link
Member

I agree this is lacking. I have been wanting to improve doxygen main page.

ProfFan added a commit that referenced this issue Feb 16, 2021
@ProfFan
Squashed 'wrap/' changes from 85d34351c..b28b3570d
8d49d7d 
b28b3570d Merge pull request #30 from borglab/feature/remove_install
cc2b07193 Cleanup
610ca176b Allow GTWRAP to be installed in a prefix
193b922c6 Merge pull request #29 from borglab/feature/remove_install
6d2b6ace6 fix path to package
e5f220759 clean up some leftover code
b0b158a0a install python package as a directory
3f4a7c775 Allow usage without install into global env
5040ba415 Merge pull request #28 from borglab/readme-update
14a7452fe updated README Getting Started section

git-subtree-dir: wrap
git-subtree-split: b28b3570d221b89f3568f44ed439d3a444903570
varunagrawal added a commit that referenced this issue Feb 25, 2022
@varunagrawal
Merge pull request #30 from varunagrawal/hybrid-bayes-net/evaluate
3b4c492
@isaiahoh
Copy link

Hi @dellaert,
I've started working on improved documentation for factors on my fork of GTSAM. I'm using Sphinx connected to Doxygen in a Read the Docs format. This approach allows for better organization of related terms like Factors without affecting the current documentation structure.
The Read the Docs format with Sphinx offers several advantages:

  1. Easy navigation with a sidebar for quick access to different sections
  2. Search functionality for finding specific topics

I've attached a screenshot below for a first look at the new documentation structure in the Read the Docs format. I'd appreciate your feedback on this approach and the initial layout. Let me know if this direction could be valuable for the project.
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dellaert dellaert

Labels
enhancement Improvement to GTSAM question More of a question rather than an issue
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@dellaert @isaiahoh @yetongatech