Tips for ABINIT users and developers

User Tools

Site Tools

Trace:
developers:generate_doc

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
Last revisionBoth sides next revision
developers:generate_doc [2017/10/17 09:49] – [Topics : how to add/modify ?] Xavier Gonzedevelopers:generate_doc [2018/05/26 22:43] – [The ABINIT HTML doc] Xavier Gonze
Line 1: Line 1:
-====== The ABINIT HTML doc ======+====== The ABINIT HTML doc (obsolete) ====== 
 + 
 +** THE INFORMATION ABOUT THE MANAGEMENT OF THE DOCUMENTATION HAS BEEN TRANSFERRED TO THE MAIN ABINIT SITE, AT  
 +https://docs.abinit.org/developers/abimkdocs **
  
 List of variables, lessons of the tutorial, help files, ABINIT topics, bibliography, theory documents are all important documentation files, posted on the Web, to help the users. The ~abinit/doc/generate_doc.py script generates most of these files by converting YAML files to HTML. List of variables, lessons of the tutorial, help files, ABINIT topics, bibliography, theory documents are all important documentation files, posted on the Web, to help the users. The ~abinit/doc/generate_doc.py script generates most of these files by converting YAML files to HTML.
Line 51: Line 54:
  
 At variance, the other sections of the topic_NAME.html are created from other sources. The list of input variables that are relevant to this topics is assembled from the information At variance, the other sections of the topic_NAME.html are created from other sources. The list of input variables that are relevant to this topics is assembled from the information
-given for these input variables, see [[#input variableshow_to_add_modify|Input variables : how_to_add_modify]], as well as [[developers:topics_and_tribes]], while the list of relevant input files+given for these input variables, see [[#input variableshow_to_add_modify|Input variables : how_to_add_modify]], as well as [[developers:topics_and_relevances]], while the list of relevant input files
 is assembled from the information in each of these input files (add a line "#%% topics = " in the last section of the input file.). The bibliography list is assembled is assembled from the information in each of these input files (add a line "#%% topics = " in the last section of the input file.). The bibliography list is assembled
 from the references cited in the "introduction" section, that use [[developers:link_shortcuts|Shortcuts for Web links]]. from the references cited in the "introduction" section, that use [[developers:link_shortcuts|Shortcuts for Web links]].