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

Fix extras hyperlink #1463

Closed
wants to merge 1 commit into from
Closed

Fix extras hyperlink #1463

wants to merge 1 commit into from

Conversation

m1so
Copy link

@m1so m1so commented Oct 12, 2019

Pull Request Check List

This is just a reminder about the most common mistakes. Please make sure that you tick all appropriate boxes. But please read our contribution guide at least once, it will save you unnecessary review cycles!

  • Added tests for changed code.
  • Updated documentation for changed code.

Note: If your Pull Request introduces a new feature or changes the current behavior, it should be based
on the develop branch. If it's a bug fix or only a documentation update, it should be based on the master branch.

If you have any questions to any of the points above, just submit and ask! This checklist is here to help you, not to deter you from contributing!

@kasteph kasteph added the area/docs Documentation issues/improvements label Oct 12, 2019
Copy link
Member

@kasteph kasteph left a comment

Choose a reason for hiding this comment

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

@m1so thanks for your contribution! 🍡 💫

I just looked at your PR and it looks like the hyperlink is missing an extra parent docs in the path.

@m1so
Copy link
Author

m1so commented Oct 13, 2019

Hey @stephsamson, not sure what you mean exactly.

It seems like other pages use the same url structure when linking across sections. For example: https://github.com/sdispater/poetry/blob/master/docs/docs/configuration.md#L3

Additionally, https://poetry.eustace.io/docs/pyproject/#extras seems to work just fine in the browser.

Please let me know if I missed something

@m1so m1so requested a review from kasteph October 13, 2019 19:05
@kasteph
Copy link
Member

kasteph commented Oct 14, 2019

Hey @m1so thanks for the quick response! You're right that it's the structure in the other sections but it looks to be breaking on the GitHub docs page too when you click on the link from that page in line 3: see here.

Yes, that link works fine in the browser but the problem is the linking in the GitHub docs page. Ideally, neither would be breaking :(

@m1so
Copy link
Author

m1so commented Oct 14, 2019

Oh I see... could maybe the docs folder be moved one level down, placing the mkdocs.yml to the root of the repo and moving the theme folder to possibly /assets?

Not really sure how the aforementioned placement would affect building the docs as I couldn't find any related commands in the Makefile.

Another solution might be changing https://www.mkdocs.org/user-guide/configuration/#docs_dir to . instead of the default docs and subsequently removing the /docs/docs directory.

@finswimmer
Copy link
Member

It looks like this is fixed in the meantime.

Thanks a lot for your contribution anyway 👍

@finswimmer finswimmer closed this Sep 15, 2020
Copy link

github-actions bot commented Mar 1, 2024

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 1, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area/docs Documentation issues/improvements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants