Link not showing up - Githubissues

openworm / openworm_docs

Documentation for OpenWorm, i.e. docs.openworm.org

http://docs.openworm.org

43 stars 27 forks source link

Link not showing up #20

Closed MichaelCurrie closed 9 years ago

MichaelCurrie commented 9 years ago

I can't understand this inconsistent behaviour in the way the .rst file is being interpreted.

In this file:

On GitHub: background.rst
After being rendered: http://docs.openworm.org/en/latest/background.html

The link to full_history is not being recognized.

But on the next line, in what to my eye is identical syntax, the link to releases is!

Any ideas?

tarelli commented 9 years ago

I tried removing the underscore just in case without luck, trying to think of the next dumb thing to try :)

tarelli commented 9 years ago

@MichaelCurrie fixed it, needed to add an anchor at the top of fullhistory.rst .. _fullhistory: btw is fullhistory.md file required?

MichaelCurrie commented 9 years ago

Thanks for the fix!

"is full_history.md file required?"

Good question, and no, it's not required. I'm trying to keep the file exactly the same as full_history.rst.

I see a few others in the docs with a parallel .md file also, and I suspect it's because it's not just me who prefers to edit .md files because of their more forgiving syntax. I'd prefer to keep both so I can have a workflow of editing the .md then converting to .rst through the pandoc tool.