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

Update sphinx documentation #10

Merged
merged 2 commits into from
Sep 4, 2023
Merged

Update sphinx documentation #10

merged 2 commits into from
Sep 4, 2023

Conversation

NikAzanov
Copy link
Contributor

@NikAzanov NikAzanov commented Aug 16, 2023

Improve documentation structure, sphinx configuration and make scripts to build docs

This is not the final state of docs because there are still some changes required for package. I decided to prepare docs structure, then make changes and update docs accordingly

@NikAzanov NikAzanov requested a review from yalef as a code owner August 16, 2023 01:20
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
django-import-export-extensions is a Django application and library based on
`django-import-export` library that provided extended features.

**Features:**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you add links to docs of each feature?

docs/api_drf.rst Outdated
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add some prefix for docs (or move them to separate folder) that contains just autogenerated docs

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But they already have api_ prefix

@NikAzanov NikAzanov changed the title SA3P-26 Update sphinx documentation Update sphinx documentation Aug 21, 2023
@NikAzanov NikAzanov merged commit b7915de into main Sep 4, 2023
26 checks passed
@NikAzanov NikAzanov deleted the update-docs branch September 4, 2023 08:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants