View Issue Details

IDProjectCategoryView StatusLast Update
0002565OpenFOAMBugpublic2017-09-20 19:14
Reporterwyldckat Assigned Tochris  
PrioritylowSeveritytextReproducibilityalways
Status closedResolutionfixed 
Summary0002565: Latest update to the cpp.openfoam.org website (mid-May 2017) has broken links to source code
DescriptionA couple of years ago it was introduced a feature into the script "doc/Doxygen/Allwmake" that gives the ability to replace the direct source code links to use the online version instead of the local+relative path.

This was introduced with this report: https://bugs.openfoam.org/view.php?id=1528 - There instructions are given on how to use this feature.

I remember that this feature was still working with the Doxygen page for OpenFOAM 4.0, but the recent update to the website for OpenFOAM 4.1 broke this ability.

Either way, the fix is to run the script with the option "-online", e.g.:

  foam
  doc/Doxygen/Allwmake -online

Steps To ReproduceNotice the following pages:

 - For OpenFOAM 3.0.1: https://cpp.openfoam.org/v3/a00412.html#details
 - For OpenFOAM 4.1: https://cpp.openfoam.org/v4/classFoam_1_1coupledFvPatchField.html#details
 - For OpenFOAM-dev: https://cpp.openfoam.org/dev/classFoam_1_1coupledFvPatchField.html#details

In the text block:

   Source files

        coupledFvPatchField.H
        coupledFvPatchField.C

the links for 3.0.1 point to the source code at Github, but the other two versions point to the local path at cpp.openfoam.org
Additional InformationIf by any chance you don't want to have to launch the script again, it is possible to try and do a quick sed fix, depending on the version:

  For OpenFOAM 4.1:

    find html/ -name "*.html" -type f | xargs sed -i -e 's|href="../../../|href="https://github.com/OpenFOAM/OpenFOAM-4.x/tree/version-4.1/|g'


  For OpenFOAM-dev:

    find html/ -name "*.html" -type f | xargs sed -i -e 's|href="../../../|href="https://github.com/OpenFOAM/OpenFOAM-dev/tree/master/src/|g'

TagsNo tags attached.

Relationships

related to 0002702 closedchris Broken links to GitHub in the Doxygen documentation of version 5. 

Activities

chris

2017-06-01 08:28

manager   ~0008198

The pages are fixed. Your test example worked correctly for me (although some people might find it takes 12 hrs for page cache to update).

Thanks for the report. The -online option duly noted for future updates of the documentation.

Issue History

Date Modified Username Field Change
2017-05-27 15:52 wyldckat New Issue
2017-05-27 15:52 wyldckat Status new => assigned
2017-05-27 15:52 wyldckat Assigned To => chris
2017-06-01 08:28 chris Status assigned => closed
2017-06-01 08:28 chris Resolution open => fixed
2017-06-01 08:28 chris Note Added: 0008198
2017-09-20 19:14 wyldckat Relationship added related to 0002702