Cleanup #19284
open
Script to find broken URLs in Ceph source code.
Added by Jos Collin about 7 years ago.
Updated about 7 years ago.
Description
It would be better to create a Script to find broken URLs in Ceph source code. This will help us to check for broken / invalid URLs periodically, instead of opening each file and check the validity of URLs.
Great idea! It's useful. We should search for whether sphinx already has such tools.
Chang Liu wrote:
Great idea! It's useful. We should search for whether sphinx already has such tools.
Such tools are available already. For instance, there are Firefox Extensions to find broken Bookmarked URLs. So You may find a script too.
Jos Collin wrote:
Chang Liu wrote:
Great idea! It's useful. We should search for whether sphinx already has such tools.
Such tools are available already. For instance, there are Firefox Extensions to find broken Bookmarked URLs. So You may find a script too.
Sphinx has a builder called `linkcheck`. It's works.
Chang Liu wrote:
Jos Collin wrote:
Chang Liu wrote:
Great idea! It's useful. We should search for whether sphinx already has such tools.
Such tools are available already. For instance, there are Firefox Extensions to find broken Bookmarked URLs. So You may find a script too.
Sphinx has a builder called `linkcheck`. It's works.
okay, Is it possible for us to integrate linkcheck in ceph ? What about the license ?
Jos Collin wrote:
Chang Liu wrote:
Jos Collin wrote:
Chang Liu wrote:
Great idea! It's useful. We should search for whether sphinx already has such tools.
Such tools are available already. For instance, there are Firefox Extensions to find broken Bookmarked URLs. So You may find a script too.
Sphinx has a builder called `linkcheck`. It's works.
okay, Is it possible for us to integrate linkcheck in ceph ? What about the license ?
yes, I'm adding a script to ceph/admin/build-doc.
linkcheck is sub-module of Sphinx, We already used sphinx. so license is not problem.
Its license said that:
- Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
Excellent, please go ahead.
- Status changed from New to In Progress
Also available in: Atom
PDF