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

API docs broken on read the docs #116

Closed
Kircheneer opened this issue Jun 29, 2022 · 0 comments · Fixed by #120
Closed

API docs broken on read the docs #116

Kircheneer opened this issue Jun 29, 2022 · 0 comments · Fixed by #120
Labels
status: accepted This issue has been accepted by the maintainers team for implementation status: help wanted This issue is tentatively accepted pending a volunteer committed to its implementation type: bug type: documentation

Comments

@Kircheneer
Copy link
Collaborator

Environment

  • DiffSync version: Current version on read the docs

Observed Behavior

This doesn't render correctly.

Expected Behavior

It should render correctly.

Steps to Reproduce

  1. Go to https://diffsync.readthedocs.io/en/latest/api/diffsync.html
@Kircheneer Kircheneer added status: accepted This issue has been accepted by the maintainers team for implementation status: help wanted This issue is tentatively accepted pending a volunteer committed to its implementation type: bug type: documentation labels Jun 29, 2022
Kircheneer added a commit that referenced this issue Jul 1, 2022
@Kircheneer
General housekeeping.
f14e86b 
- Bump python version to ^3.7 (fixes #117)
- Fix read the docs rendering by adding pydantic to the docs requirements.txt (fixes #116)
- Add entire .idea folder to the .gitignore
@Kircheneer Kircheneer mentioned this issue Jul 1, 2022
Merged
Kircheneer added a commit that referenced this issue Jul 7, 2022
@Kircheneer
General housekeeping. (#120)
7bb0a67 
* General housekeeping.

- Bump python version to ^3.7 (fixes #117)
- Fix read the docs rendering by adding pydantic to the docs requirements.txt (fixes #116)
- Add entire .idea folder to the .gitignore

Co-authored-by: Leo Kirchner <leo@kirchne.red>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
status: accepted This issue has been accepted by the maintainers team for implementation status: help wanted This issue is tentatively accepted pending a volunteer committed to its implementation type: bug type: documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

General housekeeping. networktocode/diffsync
1 participant
@Kircheneer