I follow the instructions on read the docs but I get this error:
bash Sphinx error: master file
/home/docs/checkouts/readthedocs.org/user_builds/mybinders/checkouts/latest/docs/source/contents.rst
not found
Do have to you the read the docs yaml file?
If you have your own conf.py file, it overrides Read the Doc's default conf.py. By default, Sphinx expects the master doc to be contents. Read the Docs will set master doc to index instead (or whatever it is you have specified in your settings). Try adding this to your conf.py:
master_doc = 'index'
For more information, check out this issue: https://github.com/rtfd/readthedocs.org/issues/2569
I've needed to have my conf.py because of the extensions I'm using so simply add
master_doc = 'contents'
to your conf.py and than
rename your index.rst to contents.rst.
Than after build passes OK you still won't see anything on ReadTheDocs, except "This page still doesn't exists" just go to:
https://your-project.readthedocs.io/en/latest/contents.html
And you'll see your docs there.
Related
I'm new to octave, and want to run a few commands on startup automatically every time it opens.
I typed "help startup" and saw "Octave uses the file ".octaverc". I did a bit of searching online at https://www.math.utah.edu/docs/info/octave_4.html, and saw the .octaverc file should be in the following path:
OCTAVE_HOME/lib/octave/VERSION/startup/octaverc
PROBLEM:
In that directory I don't have a startup folder, only "oct" and "site". I do see hidden files, which was my first thought since the file begins with "." character. So I then used Agent Ransack in the directory, and still nothing came up.
QUESTION:
1) Do I have to make the startup folder and octaverc file myself?
2) If so, does one, both or none have to be hidden?
3) Can it be a txt file, or does it have a special extension?
4) Do I just type the commands straight into the file or is there special formatting?
NOTE:
In case I'm going about this the wrong way, there are the operations I'd like to have run on startup:
PS1('>> '), addpath('D:\Users\Me\Desktop'), clc
Thanks ahead of time for the help!!
Possible locations (and their differences) for octaverc files are specified in the documentation.
In short, these are, from more general to specific:
octave-home/share/octave/site/m/startup/octaverc (most generic, for entire system)
octave-home/share/octave/version/m/startup/octaverc (to cover for more than one octave versions installed on the system, possibly requiring different startup scripts)
~/.octaverc (where ~ is unix-speak for a user's home directory -- covering for user-specific startup files)
.octaverc files in any directory, creating specific startup conditions for specific directories
octaverc files are effectively simple script files that are executed from most generic to most specific each time octave starts. Therefore, in the presence of conflicting commands, the more specific file can effectively be used to override the more generic behaviour.
Octave also supports (but does not recommend) the use of the startup.m file, for matlab compatibility.
You might also want to check out pathdef and savepath as well.
As a more general tip, if you ever want to search for a specific keyword from the documentation (e.g. octaverc), you can type this kind of search query in duckduckgo (or google):
octaverc site:https://octave.org/doc/interpreter/
(or just download the documentation as pdf and search the pdf)
Found the solution, the file was in the following path:
OCTAVE_HOME/share/octave/site/m/startup
to find out where OCTAVE_HOME is for you, just type "OCTAVE_HOME" into your Octave command line window.
ANSWERS:
1) You do not have to make a startup octaverc file yourself
2) The file is actually not hidden, so it should be easy to find given you're looking in the right place.
3) The file doesn't have an extension. It's just octaverc.
4) Under the last line of the existing file, you can just append commands as you would type them at the Octave command line window.
the last(7.3.0) octave version placed HERE:/ does not find the THERE:/openEMS/matlab directory even it is already loaded with octaverc or addpath. It keeps looking into the work dir where openEMS is not placed and does not recognize, for instance, the 'physical_constants.m' file.
I am trying to see configuration page of the KNIME node which i just published to my KNIME analytics tool.
Getting error "Error while creating node dialog for 'Readadwords': The configName must be a non-empty string" where Readadwords is my node dialog class which i created in eclipse.
Either in my Nodemodel or Nodedialog there is not a single config and i have defaulted it some or other string value.
Can some one help me where to look to fix my error and also please let me know if i can debug my knime plugin from eclipse rather than doing it in Analytics tool.
Debugging is explained in their developer guide, this page is the most relevant for that.
When you save your settings you have not specified the key for your config, that is what this error message is about. Like in this place assuming "" were used instead of "colName", I would expect a similar error message.
Issue is KNIME is not picking up the changes i have done to the code and i had to change version in plugin.xml file then it started working after copying new jar file to dropins folder of KNIME
The question seems long, but it all comes down to how I can add header files to specific extension specification.
The motivation is that if I change one of the header files, issuing
python setup.py build
should rebuild the extension even when none of the .c files are changed.
I've tried to add the depending header files in "sources" keyword arg in the Extension constructor, but running the resulting setup.py generated errors complaining about unknown file extension ".h".
Thanks!
Take a look at the depends option on the Extension class. I've not used it myself, but your exact example is listed as a use-case.
I'm trying to have a standard code style for my project, and I have found http://editorconfig.org/, that is a standard for that. I like it very much, and Intellij supports it (we use Intellij).
I have a .eslintrc file (extend from airbnb style).
So, how to get .editorconfig file from that .eslintrc file ?
If you are looking for a .editorconfig that configures the style enforced by the eslint-config-airbnb rules, you could use the .editorconfig file from that module's repo:
https://github.com/airbnb/javascript/blob/master/.editorconfig
I found eslint-to-editorconfig for this purpose, but I have had trouble getting it to work extending rules from the airbnb base rules. Perhaps you will have better luck:
$ ./node_modules/.bin/eslint-to-editorconfig
/path/to/app/node_modules/eslint-to-editorconfig/node_modules/eslint/lib/config/config-file.js:402
throw e;
^
Error: /path/to/app/node_modules/eslint-config-airbnb-base/rules/es6.js:
Configuration for rule "arrow-parens" is invalid:
Value "as-needed,[object Object]" has more items than allowed.
Referenced from: airbnb-base
Referenced from: /path/to/app/.eslintrc
The easiest way to create a large and complete editorconfig is with IntelliJ.
You can change the settings as you want in the config and then extract the editorconfig
I have two libraries libA and libB.
libA contains a file Action.h
libB contains a file action.h
I want to generate doxygen documentation in the same output directory for both libraries. This directory is to be used in Windows, for which action.html and Action.html is unfortunately considered to be the same file. To prevent this clash, I wish to render the generated files unique by prepending their path names to them.
Therefore, I set FULL_PATH_NAMES to YES.
I expect to see something like libA_Action.html and libB_action.html when I generate the documentation, but I don't! I still see Action.html and action.html. Its as if the FULL_PATH_NAMES parameter does nothing at all. Do I also need to set some other parameter in the Doxyfile to make the FULL_PATH_NAMES parameter work correctly?
You're probably running doxygen twice - one time for each library. If that is the case, doxygen isn't aware of the fact that it might clash with an output from another run, so when it find an existing file, it assumes that it is leftover from a previous run, and overrides it.
Setting FULL_PATH_NAMES doesn't help, as doxygen has no idea that multiple libraries exist, so, as far as doxygen is concerned, the prefix is identical to all files, so even when you adding a force it, it adds nothing (That's probably a bug).
The solution to your problem is setting both libraries as inputs to the same doxygen project.
You can do it by setting INPUT to multiple folders in the configuration file:
INPUT = ...bla\Lib1 \
...bla\Lib2