{"action":"created","issue":{"url":"https://api.github.com/repos/rtfd/recommonmark/issues/8","repository_url":"https://api.github.com/repos/rtfd/recommonmark","labels_url":"https://api.github.com/repos/rtfd/recommonmark/issues/8/labels{/name}","comments_url":"https://api.github.com/repos/rtfd/recommonmark/issues/8/comments","events_url":"https://api.github.com/repos/rtfd/recommonmark/issues/8/events","html_url":"https://github.com/rtfd/recommonmark/issues/8","id":100648424,"number":8,"title":"Add support for cross-referencing","user":{"login":"sid-kap","id":6425077,"avatar_url":"https://avatars.githubusercontent.com/u/6425077?v=3","gravatar_id":"","url":"https://api.github.com/users/sid-kap","html_url":"https://github.com/sid-kap","followers_url":"https://api.github.com/users/sid-kap/followers","following_url":"https://api.github.com/users/sid-kap/following{/other_user}","gists_url":"https://api.github.com/users/sid-kap/gists{/gist_id}","starred_url":"https://api.github.com/users/sid-kap/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/sid-kap/subscriptions","organizations_url":"https://api.github.com/users/sid-kap/orgs","repos_url":"https://api.github.com/users/sid-kap/repos","events_url":"https://api.github.com/users/sid-kap/events{/privacy}","received_events_url":"https://api.github.com/users/sid-kap/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":4,"created_at":"2015-08-12T22:25:53Z","updated_at":"2016-06-14T17:17:51Z","closed_at":null,"body":"It would be nice to have something like http://sphinx-doc.org/markup/inline.html\r\n\r\nIn rST you can do \r\n```rst\r\n:doc:`A link <relative/path/to/page>`\r\n```\r\nrST supports other directives as well, but I think referencing documents is the most important.\r\n\r\nGithub Wiki supports something like this with the Mediawiki syntax: (see https://help.github.com/articles/adding-links-to-wikis/)\r\n```\r\n[[A link|Page location]]\r\n``` \r\nI'm not a huge fan of this syntax. I think the syntax should be more similar to the ordinary markdown link syntax. Maybe something like:\r\n```markdown\r\n[A link](/path/to/page)\r\n```\r\n(here we assume that any link beginning with `/` is a cross-reference to another page in the Sphinx directory, relative to the source directory. In sphinx, a link starting with `/` is considered a path from the root.)\r\n \r\nDoes something like this seem like a good idea? In general, adding syntax rules to Markdown is frowned upon, but this one might be worth it. I can't see how you could make an entire readthedocs site in markdown with using relative references."},"comment":{"url":"https://api.github.com/repos/rtfd/recommonmark/issues/comments/225951852","html_url":"https://github.com/rtfd/recommonmark/issues/8#issuecomment-225951852","issue_url":"https://api.github.com/repos/rtfd/recommonmark/issues/8","id":225951852,"user":{"login":"pfultz2","id":1306044,"avatar_url":"https://avatars.githubusercontent.com/u/1306044?v=3","gravatar_id":"","url":"https://api.github.com/users/pfultz2","html_url":"https://github.com/pfultz2","followers_url":"https://api.github.com/users/pfultz2/followers","following_url":"https://api.github.com/users/pfultz2/following{/other_user}","gists_url":"https://api.github.com/users/pfultz2/gists{/gist_id}","starred_url":"https://api.github.com/users/pfultz2/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/pfultz2/subscriptions","organizations_url":"https://api.github.com/users/pfultz2/orgs","repos_url":"https://api.github.com/users/pfultz2/repos","events_url":"https://api.github.com/users/pfultz2/events{/privacy}","received_events_url":"https://api.github.com/users/pfultz2/received_events","type":"User","site_admin":false},"created_at":"2016-06-14T17:17:51Z","updated_at":"2016-06-14T17:17:51Z","body":"Ok, so I updated the parser to use `pending_xref` for references in this branch [here](https://github.com/pfultz2/recommonmark/tree/pending-xref). However, it requires sphinx to be updated with this pull request [here](https://github.com/sphinx-doc/sphinx/pull/2644).\r\n\r\nFor links that use `http://` or `https://`, it still uses `docutils.nodes.reference`, since they are external but other links are added using `pending_xref` with the type set to `any`. This is really nice, and allows me to cross reference more than just documents.\r\n\r\nOnce the pull request is merged into sphinx, I can send a pull request for this as well(although sphinx has yet to respond to my pull request)."}}
{"actor":{"display_login":"pfultz2"}}