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

Docs: Updated sphinx & links clean up #240

Merged
merged 3 commits into from
Aug 1, 2023

Conversation

denisSurkov
Copy link
Contributor

Description

Solves #231

I've updated sphinx & sphinx theme. I could not see much difference, but keeping deps up-to-date is always good.

Added 'sphinx.ext.autosectionlabel'. This extension allows to make links like <document-name:title inside document>. I think it's easer to maintain links with this notation. If you don't think so, I could revert custom anchors back.

How to build docs:

cd docs/
pip install -r requirements.txt
make html

@denisSurkov
Copy link
Contributor Author

@Andrew-Chen-Wang , hi!

Can you help with review, please?

@Andrew-Chen-Wang
Copy link
Collaborator

reverting the anchors would be great. I think it's a neat add on but not for me. thanks!

@coveralls
Copy link

coveralls commented Jul 19, 2023

Pull Request Test Coverage Report for Build 5600566202

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.05%) to 98.197%

Totals Coverage Status
Change from base Build 5515505785: 0.05%
Covered Lines: 708
Relevant Lines: 721

💛 - Coveralls

@denisSurkov
Copy link
Contributor Author

reverting the anchors would be great.

I've reverted manual anchors back.

@denisSurkov
Copy link
Contributor Author

@Andrew-Chen-Wang , can you help with review?

@denisSurkov
Copy link
Contributor Author

@Andrew-Chen-Wang, sorry for being annoying, but I think this is very small fix, but helpful one.

Copy link
Collaborator

@Andrew-Chen-Wang Andrew-Chen-Wang left a comment

Choose a reason for hiding this comment

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

sorry @denisSurkov but thanks for the reminder it lgtm!

@Andrew-Chen-Wang Andrew-Chen-Wang merged commit 2a352aa into noripyt:master Aug 1, 2023
@denisSurkov
Copy link
Contributor Author

@Andrew-Chen-Wang , nothing has changed at https://django-cachalot.readthedocs.io/en/latest/introduction.html.

Do you need to call some commands to refresh render?

@Andrew-Chen-Wang
Copy link
Collaborator

rtd hook might be failing will take a look

@denisSurkov
Copy link
Contributor Author

@Andrew-Chen-Wang , kindly reminder to check read-the-docs webhook.

I don't know, but this might be helpful: https://docs.readthedocs.io/en/stable/guides/setup/git-repo-manual.html

@Andrew-Chen-Wang
Copy link
Collaborator

Andrew-Chen-Wang commented Aug 8, 2023

Thank you for the reminder.
Screenshot 2023-08-08 at 11 43 51 AM

It turns out a configuration file is now required. I have now added it to master.

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.

3 participants