conda-forge / conda-forge.github.io

The conda-forge website.
https://conda-forge.org
BSD 3-Clause "New" or "Revised" License
128 stars 275 forks source link

Invalid link is provided in the to-do list (Miscellaneous section) #1314

Open prachinandi opened 3 years ago

prachinandi commented 3 years ago

In the Miscellaneous section of Conda-forge documentation https://conda-forge.org/docs/misc/00_intro.html#term-abi the link is invalid, may be coz of typo error. Screenshot (91)_LI

prachinandi commented 3 years ago

@viniciusdc please assign me with this issue I wud like to work on it.

viniciusdc commented 3 years ago

@viniciusdc please assign me with this issue I wud like to work on it.

done!

viniciusdc commented 3 years ago

@prachi237 Thanks for the PR #1318, but could look into the other files inside .src and check if there isn't any other place where that phrase appears? I am seeing a duplicate in https://conda-forge.org/docs/misc/00_intro.html#term-abi

viniciusdc commented 3 years ago

That's caused because Sphinx auto-generates the todolist based on the todo presented in the docs (see here for more information), then to solve this we can work with

or adding the correct link directly to the todo message

prachinandi commented 3 years ago

That's caused because Sphinx auto-generates the todolist based on the todo presented in the docs (see here for more information), then to solve this we can work with

  • todo_link_only: If this is True, todolist produces output without file path and line, The default is False.

or adding the correct link directly to the todo message

ok sir I'll look into this, but is that auto-generated ? so I guess their was no typo error

viniciusdc commented 3 years ago

That's caused because Sphinx auto-generates the todolist based on the todo presented in the docs (see here for more information), then to solve this we can work with

  • todo_link_only: If this is True, todolist produces output without file path and line, The default is False.

or adding the correct link directly to the todo message

ok sir I'll look into this, but is that auto-generated ? so I guess their was no typo error

I think so