Code Monkey home page Code Monkey logo

Comments (4)

bmarshall13 avatar bmarshall13 commented on September 6, 2024

I'm not sure if this is an issue or not.

I am building this repo with make html while in f5-ci-docs/docs

The paths are these:

  1. f5-ci-docs/docs/f5-fpp/README.rst
  2. f5-ci-docs/docs/f5-fpp/_includes/topic_kubernetes-notes.rst
  3. f5-ci-docs/docs/f5-fpp/_static/example-service-flowpoint.yaml

1 contains .. include:: _includes/topic_kubernetes-notes.rst referencing 2
2 contains .. literalinclude:: _static/example-service-flowpoint.yaml referencing 3

1 correctly renders the content in 3, which is suprising. It shows that the relative root of the literalinclude is that of 1, and not 2 where the statement exists.

The problem here is that I can only include that content from a specific directory. To prove this to myself, I also include 2 from f5-ci-docs/docs/index.rst. That doesn't render correctly.

However,

from f5-ci-docs.

bmarshall13 avatar bmarshall13 commented on September 6, 2024

The docs say that the path should be relative to the file doing the importing, but this doesn't appear to be the case.

http://www.sphinx-doc.org/en/stable/markup/code.html#includes

from f5-ci-docs.

jputrino avatar jputrino commented on September 6, 2024

added to lightweight-proxy; see project Makefile.

from f5-ci-docs.

jputrino avatar jputrino commented on September 6, 2024

rST epilog needs to be controlled from f5-ci-docs to ensure consistency and easy updating across all docs.

from f5-ci-docs.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.