GithubHelp home page GithubHelp logo

Comments (3)

JacquesLucke avatar JacquesLucke commented on July 22, 2024

hmmm unfortunally I don't know :D
I will try to find it out if you didn't already.. I think I only know how to create external links and didn't found out to make links within the manual.. Will have to check that.
I'm not very used to sphinx and rst myself so far, unfortunally.

from animation_nodes_manual.

hapit avatar hapit commented on July 22, 2024

http://www.sphinx-doc.org/en/stable/markup/inline.html

One way is as reference, then you need a label as the reference target.

### Label: 
.. _my-reference-label:
### Link:
:ref:`Text displayed for Link <my-reference-label>`

Other way is to directly link to the document.

:doc:`/path/to/file`   # Linktext is caption of target page
:doc:`Linktext </path/to/file>`

The problem with labes is, that they must be unique throughout the manual.
I would suggest using :doc: to make links to other documents and :ref: inside a page with a unique page prefix for the label. The problem with :doc: is if the page is moved sometime in the future.

What is your oppinion about it?

from animation_nodes_manual.

OmarEmaraDev avatar OmarEmaraDev commented on July 22, 2024

We no longer use sphinx.

from animation_nodes_manual.

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.