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

[doc/changelog] link objects to api doc #453

Closed
marscher opened this issue Jul 29, 2021 · 4 comments · Fixed by #552
Closed

[doc/changelog] link objects to api doc #453

marscher opened this issue Jul 29, 2021 · 4 comments · Fixed by #552
Labels
documentation Improvements or additions to documentation

Comments

@marscher
Copy link
Collaborator

No description provided.

@marscher marscher added the documentation Improvements or additions to documentation label Jul 29, 2021
@CagtayFabry
Copy link
Member

sounds great, is there a way we could make this work?

@marscher
Copy link
Collaborator Author

marscher commented Aug 2, 2021

I gave it a shot by setting directive "currentmodule" to make sphinx find the objects during inclusion of the changelog. Without success yet.

@marscher
Copy link
Collaborator Author

marscher commented Aug 5, 2021

Lets see: CrossNox/m2r2#37

@marscher
Copy link
Collaborator Author

marscher commented Aug 6, 2021

@CagtayFabry suggested to convert the changelog to RST and store it directly in the documentation, this would make it easier to achieve the linking of objects. We also need to consider what happens with deleted objects (unlink them manually, silent failure, etc.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants