Closed. This question is not reproducible or was caused by typos. It is not currently accepting answers.
This question was caused by a typo or a problem that can no longer be reproduced. While similar questions may be on-topic here, this one was resolved in a way less likely to help future readers.
Closed 2 years ago.
Improve this question
I can't find the answer after much Googling.
I am making my first foray into sphinx, and I can't see how to include links to another page within my sphinx docs. It seems that the :doc directive should do the trick, but it isn't working.
For example, imagine I have the very simple tree:
./index.rst
./files/CPPFiles.rst
./files/PythonFiles.rst
The first one, index.rst as well as having a TOC wants a link to one of these subfiles in the "free" text, so my index.rst contains this:
My Docs
=======
This is a Python module but powered by a C++ back end.
Unless you're planning on extending this module you only need
to read :doc:`the Python docs<files/PythonFiles>`.
.. toctree::
:maxdepth: 2
:caption: Contents:
files/PythonFiles
files/CPPFiles
I've also tried with just
:doc`files/PythonFiles`
In both cases, the text within the :doc: appears as expected, but is not a link.
White space has meaning in reStructuredText.
:doc:`the Python docs<files/PythonFiles>`.
Should be:
:doc:`the Python docs <files/PythonFiles>`.
Related
Closed. This question is not reproducible or was caused by typos. It is not currently accepting answers.
This question was caused by a typo or a problem that can no longer be reproduced. While similar questions may be on-topic here, this one was resolved in a way less likely to help future readers.
Closed 1 year ago.
Improve this question
I want to include accented characters in a Sphinx heading such that I will see the following result:
Finalé
I have tried the following strategies:
Use the unicode character directly such as:
Finalé
======
but the character is considered invalid by Docutils.
Also, I have tried using the strip_html specification in conf.py along with the following text:
Finalé
==============
But the text is left unchanged and the HTML entity is passed through.
Can anyone suggest a way of handling accented characters in Sphinx that will work in all situations and where the final output may be HTML or Latex?
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
Questions asking for code must demonstrate a minimal understanding of the problem being solved. Include attempted solutions, why they didn't work, and the expected results. See also: Stack Overflow question checklist
Closed 9 years ago.
Improve this question
I would like to be able to write my own version of a dependency walker tool (I think this is a good way to learn things).
However, I don't have the necessery knowledge to be able to know, given a PE file (dll/exe) - what are it's depenencies.
I would appreciate a reference to a place that can supply me this knowledge (tutorial / article / literature / etc..).
Thanks!
It's straight forward in principle (pseudo-code off the top of my head):
Create empty dependency list (list 1)
Create empty list of references yet to be looked at (list 2)
Add main module to list 2
repeat
Select first module in list 2
Open the PE file
Parse header to find import section
Enumerate import modules
for each module imported
if not already in list 1, Add it
if not already in list 2, Add it
Remove from list 2
until list 2 is empty.
Result in list 1.
To figure out how to actually parse the relevant parts of a PE, you can get the Portable Executable specification off of msdn.microsoft.com.
Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 8 years ago.
Improve this question
I have a project I am working on that is written in Python. The variable/class/function/everything names do not adhere to the Python style guide.
example: a variable might be called myRandomVariable instead of the proper: my_random_variable
My question is, is it worth combing through all the code (around 10,000 lines) to fix all the naming convention problems or should I just say, 'the heck with it -- it works'?
Thanks
Edited to give example
Just because there is a Python style guide, it does not mean that all Python code should adhere to it. The most important thing to consider in a code base is that it's consistent with itself, at LEAST on a per-file basis, preferably across the project!
I would vote for your second option. They are just styles. Everyone will have their own style. You don't need to be in compilance with defined styles to say your product is great.
Closed. This question is off-topic. It is not currently accepting answers.
Want to improve this question? Update the question so it's on-topic for Stack Overflow.
Closed 11 years ago.
Improve this question
If i have such links in my site (i am using mvcsitemap):
http://mysite.com/coollink
http://mysite.com/coollink#contanttab1
http://mysite.com/coollink#contenttab2
If i want to submit site map to google for example, should i use the links with # in mysite XML sitemap? or better not to use them in sitemap XML?
Because in such case there would be 3 links to the same resource as i understand and it is not so good for SEO? could some one correct me if i am wrong.
As far as I know so far, hashes will be ignored by most of the search engines and they have no use for SEO. It is user more for internal page navigation or some sort of JavaScript actions.
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
I want to format my existing comments as 'RDoc comments' so they can be viewed using ri.
What are some recommended resources for starting out using RDoc?
A few things that have bitten me:
:main: -- RDoc uses only the last one evaluated; best to make sure there's only one in your project and you don't also use the --main command-line argument.
same as previous, but for :title:
:section: doesn't work very well
RDoc uses SimpleMarkup so it's fairly simple to create lists, etc. using *, - or a number. It also treats lines that are indented at the same column number as part of the same paragraph until there is an empty line which signifies a new paragraph. Do you have a few examples of comments you want RDoc'ed so we could show you how to do them and then you could extrapolate that for the rest of your comments?