[llvm-bugs] [Bug 42505] New: :manpage: directive uses direct url to llvm.org not relational one

via llvm-bugs llvm-bugs at lists.llvm.org
Thu Jul 4 00:21:42 PDT 2019


https://bugs.llvm.org/show_bug.cgi?id=42505

            Bug ID: 42505
           Summary: :manpage: directive uses direct url to llvm.org not
                    relational one
           Product: Documentation
           Version: trunk
          Hardware: All
                OS: All
            Status: NEW
          Severity: enhancement
          Priority: P
         Component: General docs
          Assignee: unassignedbugs at nondot.org
          Reporter: alexbrachetmialot at gmail.com
                CC: llvm-bugs at lists.llvm.org

I want to preface this by saying I know very little about reStructuredText or
webpages and the structure of websites, please bear with me on my description
here. Also, if there were a severity level less than enhancement it would be
that.

When using the `:manpage:` directive in .rst files it creates links which are
relative to llvm.org not the local directory. For example, when you build the
docs, the links (most of them) the links are relative to docs/ so when you
click around you are seeing your documentation. But links created from
`:manpage:` are linked to llvm.org/docs/CommandGuide see here
https://github.com/llvm/llvm-project/blob/master/llvm/docs/conf.py#L281.

This isn't just a very small inconvenience (emphasis on small) for those
building the docs locally, it means the documentation can never be hosted by
either someone other than llvm, or would be annoying if the documentation moves
from llvm.org/docs/CommandGuide/ to somewhere else on llvm.org.

-- 
You are receiving this mail because:
You are on the CC list for the bug.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/llvm-bugs/attachments/20190704/30b42917/attachment.html>


More information about the llvm-bugs mailing list