Doxygen now allows to link md files to other md files with regular markdown syntax:
How do I link between markdown documents in doxygen?
I have the following file structure:
MyDir/README.md
MyDir/Docs/other.md
Linking from README.md to other.md is straigforward:
[My link](Docs/other.md)
However linking from other to Readme is not working:
[My back link](README.md)
Since doxygen generates its links relative to where it is run, and I am running doxygen on MyDir, that should be the correct relative path. I also tried
[My back link](../README.md)
Just in case, but no luck.
Related
I am trying to document an api written in Dart with dartdoc.
The dart files i am trying to document are not in a "/lib" folder so when i launch dartdoc at the root of my api i get the following message:
Documented 0 libraries in 0.2 seconds.
dartdoc could not find any libraries to document. Run `pub get` and try
again.
Success! Docs generated into /home...
But the only documentation i get is the text written in the readME.md file.
My structure is something like this:
/apiRoot
pubspec.yaml
....
/web
/controllers
dartfiles_to_document.dart
.....
I read about official dartdoc documentation and searched there but found no solution to my problem.
I am looking for a way to generate documentation for those dart files.
In OpenCV source dir, there is a doc dir. But, this dir contains no pdf files. How can I get files like "opencv_tutorials.pdf", "opencv_cheatsheet.pdf"?
Thanks!
You need doxygen for this. You can install it from http://www.doxygen.nl and then run the doxygen executable on the doxyfile.in. This should generate documentation files in html, pdf (if you have latex installed), etc.
Note that you'll probably find all the tutorials and PDFs you'll need online as well. Using these generated files have the risk of being outdated very soon.
Background
I originally asked a question on Stackoverflow, asking how I add the IOP document class to the list of available document classes in Lyx. (I will try to remove or merge that out dated quesiton.)
I now understand that this is a 2-stage process. Stage 1 is to install IOP styles and cls files etc for Texlive, and Stage 2 is to update Lyx to be able to use these.
I have now successfully done this on a Linux Mint distro. The method is described below. I will try to keep this updated if anything changes. Hopefully I have provided enough info for anyone to be able to do this regardless of distribution or OS. If not, add a comment so I can add required info.
Useful References:
The following items helped me complete this process:
Lyx Wiki Page for IOP: http://wiki.lyx.org/Layouts/Iopart
Section 5.1 of the Customization Manual (Help) Document provided in Lyx.
Open Lyx and Goto: Help -> Customization -> Section 5.1 of Document
The IOP Latex Document download page: ftp://ftp.iop.org/pub/journals/ioplatexguidelines.tar.gz
Stage 1 - Installing IOP Document Files for Texlive (Or Miktex)
Windows Users: Check this link for directory location info: http://wiki.lyx.org/Layouts/Iopart
The first step is to download the relevant files for IOP documents from here: ftp://ftp.iop.org/pub/journals/ioplatexguidelines.tar.gz
If this link has expired, then do a duckduckgo search for "iop latex guidelines". The IOP have a .tar.gz file with all required files for Latex publishing included.
The next step is to find the correct Texlive directory. For me this was: /usr/share/texlive/texmf-dist/tex/latex If you are using miktex this will be different.
Using root privileges, create a directory in this folder: sudo mkdir iopart
Again using root privilages, extract the .tar.gz archive you downloaded to the directory iopart. After doing this and running the command ls, you should see the following files:
iopams.sty iopart12.clo IOPGraphicsGuidelines.pdf IOPLaTeXGuidelines.tex iopart10.clo iopart.cls IOPLaTeXGuidelines.pdf setstack.sty
Not all of these are important. You may wish to read through the PDF files which contain info on how to write an IOP accepted publication. I believe the .tex file contains an example template which may help you.
Finally, reconfigure Texlive by running the command sudo texhash.
You should now have the IOP Document Latex files installed and be able to use them with texlive.
Stage 2 - Reconfigure Lyx
This step is trivial, open Lyx and goto: [Menu Bar] -> Tools -> Reconfigure
Stage 3 - Open a new Lyx Document and Test
Goto: File -> New from Template -> Select iop-article.lyx
Goto: Document -> Settings : Check that the document type is "iop article"
Click the "View" button in Lyx which compiles and opens your document.
You should see a example pdf file with some mock contents.
Background
I originally asked a question on Stackoverflow, asking how I add the IOP document class to the list of available document classes in Lyx. (I will try to remove or merge that out dated quesiton.)
I now understand that this is a 2-stage process. Stage 1 is to install IOP styles and cls files etc for Texlive, and Stage 2 is to update Lyx to be able to use these.
I have now successfully done this on a Linux Mint distro. The method is described below. I will try to keep this updated if anything changes. Hopefully I have provided enough info for anyone to be able to do this regardless of distribution or OS. If not, add a comment so I can add required info.
Useful References:
The following items helped me complete this process:
Lyx Wiki Page for IOP: http://wiki.lyx.org/Layouts/Iopart
Section 5.1 of the Customization Manual (Help) Document provided in Lyx.
Open Lyx and Goto: Help -> Customization -> Section 5.1 of Document
The IOP Latex Document download page: ftp://ftp.iop.org/pub/journals/ioplatexguidelines.tar.gz
Stage 1 - Installing IOP Document Files for Texlive (Or Miktex)
Windows Users: Check this link for directory location info: http://wiki.lyx.org/Layouts/Iopart
The first step is to download the relevant files for IOP documents from here: ftp://ftp.iop.org/pub/journals/ioplatexguidelines.tar.gz
If this link has expired, then do a duckduckgo search for "iop latex guidelines". The IOP have a .tar.gz file with all required files for Latex publishing included.
The next step is to find the correct Texlive directory. For me this was: /usr/share/texlive/texmf-dist/tex/latex If you are using miktex this will be different.
Using root privileges, create a directory in this folder: sudo mkdir iopart
Again using root privilages, extract the .tar.gz archive you downloaded to the directory iopart. After doing this and running the command ls, you should see the following files:
iopams.sty iopart12.clo IOPGraphicsGuidelines.pdf IOPLaTeXGuidelines.tex iopart10.clo iopart.cls IOPLaTeXGuidelines.pdf setstack.sty
Not all of these are important. You may wish to read through the PDF files which contain info on how to write an IOP accepted publication. I believe the .tex file contains an example template which may help you.
Finally, reconfigure Texlive by running the command sudo texhash.
You should now have the IOP Document Latex files installed and be able to use them with texlive.
Stage 2 - Reconfigure Lyx
This step is trivial, open Lyx and goto: [Menu Bar] -> Tools -> Reconfigure
Stage 3 - Open a new Lyx Document and Test
Goto: File -> New from Template -> Select iop-article.lyx
Goto: Document -> Settings : Check that the document type is "iop article"
Click the "View" button in Lyx which compiles and opens your document.
You should see a example pdf file with some mock contents.
I have a project in directory A and files that I use in all my projects are in directory B.
When I moved a .sty file from A to B, the main .tex file does not compile anymore.
The error is that the .sty file was not found. I am puzzled because:
Directory B is included in the path of the project.
I cleaned (deleted manually) all the auxiliary files used in the previous compilations.
I refreshed the project folders .
Did anyone had similar problems? Suggestions?
The file LaTeX.sublime-build, within the Sublime Text folder . . . /Packages/LaTeXTools, contains a $PATH for different operating systems.
For example, Sublime Text 2 on an OSX operating system, has a file located at ~/Library/Application Support/Sublime Text 2/Packages/LaTeXTools/LaTeX.sublime-build. The relevant line of code for a MacTeX TexLive 2012 installation is "path": "$PATH:/usr/texbin:/usr/local/bin",. The plugin LaTeXTools looks in that path for *.sty files that are a part of the TexLive installation. While it may be possible (under some circumstances) to place the *.sty files within the working directory of the *.tex file, this particular plugin looks to the path mentioned hereinabove. So one option would be to add additional locations to the $PATH to suit the needs of the user, or simply place the *.sty files within the path that is pre-defined by the plugin developer.