[16:18:33] [## Class Started at Tue Jun 28 16:18:33 2016 ##] [16:18:33] startclass [16:18:39] Roll Call [16:18:40] Akshay Shipurkar [16:18:40] Shantanu Acharya [16:18:41] Rhitik Bhatt [16:18:42] Deepanshu Kapoor [16:18:43] Alakshendra Yadav [16:18:44] Abhishek Shrivastava [16:18:45] Yashwanth M [16:18:45] Harsh Vardham [16:18:45] Rushiprasad Narwade [16:18:46] Yogesh Joshi [16:18:46] Moiz Sajid [16:18:48] Dileep Sankhla [16:18:48] Mayank Gupta [16:18:50] Akshay cv [16:18:50] Aman Kumar [16:18:51] Jogender Kota [16:18:51] Shaurya Kalia [16:18:52] Aaditya Menon [16:18:52] Avik Mukherjee [16:18:52] Rohan Hazra [16:18:54] Rahul Bajaj [16:18:54] Karan Sharma [16:18:55] Vaibhav JAin [16:18:56] Varsha R [16:19:00] Amit Kokitkar [16:19:00] Suniva Priyadarshini [16:19:02] sandeep kumar choudhary [16:19:04] Tummala Dhanvi [16:19:09] Sudeep Mukherjee [16:19:10] Akhilesh Dhaundiyal [16:19:16] Sarah Masud [16:19:46] Ashwani Pandey [16:19:53] shalaka [16:19:56] Anagha R [16:20:07] Saurav Saha [16:20:25] Anupama Mandal [16:20:36] Harsh Vardham [16:20:39] Harsh Vardhan [16:20:42] Buvanesh Kumar [16:20:47] I hope everyone is done. [16:20:51] clearqueue [16:21:10] Question on the rst session? [16:21:12] rollcall, Sahil Joseph [16:21:14] Anyone? Anything? [16:21:14] ! [16:21:17] ! [16:21:22] ! [16:21:23] next [16:21:33] how to open the file from cmd? [16:21:34] Priyanka Sharma [16:21:43] ! [16:22:01] avik, you can open it from vim, but to view it properly you will have to use a broweser [16:22:01] Will this training help me in GSoC 2017? A general question [16:22:04] browser [16:22:08] dlpsankhla, Yes [16:22:12] next [16:22:14] next [16:22:14] Bharath vijay [16:22:15] avik you can try elink test.html [16:22:15] ! [16:22:17] shobhit upadhyay [16:22:21] amitk_, nice idea [16:22:38] ! [16:22:42] How? [16:23:03] dlpsankhla, can not explain, sorry. [16:23:08] okay [16:23:09] next [16:23:15] kushal: dates are wrong in https://dgplug.org/irclogs/2016/ can you please correct them [16:23:44] c0mrad3, I noticed that too, will be fixed later (hopefully). for now people can use the session number to identify. [16:23:45] next [16:23:55] c0mrad3, thanks for noticing that. [16:24:00] No question [16:24:04] next [16:24:04] pass [16:24:21] kushal,I'm getting some error:Unknown target name: "python programming language" http://paste.fedoraproject.org/385845/ [16:24:43] ! [16:24:54] Sorry, i am late for the roll call: Amrita Nair [16:24:56] Marcos H. Alano [16:25:00] Soory for being late [16:25:18] vbhjain, Give a blank line in line 60 and try again [16:25:20] next [16:25:28] mhalano, amrtanair_ no problem [16:25:32] Aman Singh [16:25:38] Kshitij [16:25:43] ok, thanks [16:25:48] roll call: Akash Mishra [16:26:08] roll call: Abhishek Tiwari [16:26:09] Roll call: Akshay T S [16:26:20] kushal: http://paste.fedoraproject.org/385886/14671239/ Can you please check where I am doing the error in -py arg ? [16:26:20] roll call: Mriyam Tamuli [16:26:28] ! [16:26:30] and another problem > paragraphs are not being created! [16:26:32] It's not showing up properly [16:26:53] Roll call: Aparna [16:27:19] roll call : Aditya [16:27:29] SRvSaha, the spaces between the arguments and the explanation are not same across the file. [16:27:43] avik, Give a blank line for new paragraph [16:27:46] next [16:27:54] grid table, i am getting the error of "Blank line required after table" [16:28:00] *in grid table! [16:28:09] thisisashwani, so give a blank line [16:28:24] it took in one case but next time didnt? [16:28:25] kushal: Sorry wrong link pasted. I'm giving the updated link asap [16:28:45] ! [16:28:52] kushal: I did give, but the error persisted [16:29:07] thisisashwani, then show us the file [16:29:19] avik, unless you show us the source, and the error [16:29:31] we can not guess what is going on, correct? [16:30:28] next [16:30:42] kushal: sorry, sorry! i missed a + symbol at the very end, that's why the error! [16:31:00] thisisashwani, hehe, nothing to be sorry about. We all do mistakes. [16:31:11] code: [16:31:21] Is there any particular reason to use rst other than that it is used in python community? [16:31:34] kushal: still i wanted to know is there an easier way to make grids [16:31:46] code: paste.fedoraproject.org/385893/ [16:31:48] the ways i am making it, it seems to me i am doing it wrong! [16:31:49] thisisashwani, I don't know actually :( [16:31:58] kushal: okay! [16:32:04] I mean we have alternatives like markdown [16:32:04] kushal: Updated link http://paste.fedoraproject.org/385890/24221146/ Still the same problem [16:32:15] D1mz, I use it because I am doing it for a long time, and it does what I want, and it is easy [16:32:45] kushal, thank you [16:32:51] code: paste.fedoraproject.org/385894/67124346/ [16:32:58] output^^ [16:33:04] SRvSaha: what error are you getting? [16:33:10] Pabitra Pati [16:33:13] roll call [16:33:15] sorry not code [16:33:28] avik, what is the error? [16:33:31] next [16:33:46] SRvSaha: seems more like a problem of indentation, you mixed tabs and spaces? [16:34:10] thisisashwani: I am not seeing py as C, C++ and Java in output [16:34:14] see in the 1st paragraph, the lines are all collasped! [16:34:36] although i have blank lines [16:34:40] avik, when you are pasting, you should paste with https:// that way we can click [16:35:07] very sorry kushal [16:35:12] thisisashwani: So, what should it be. Should there be equal indentation between the arg and the description [16:35:13] avik, no problem [16:35:15] avik, https://shellshare.net/r/summertraining [16:36:50] SRvSaha: i am trying it on my laptop, wait for a moment. [16:38:21] avik, it works [16:38:38] so what was the problem? [16:38:51] nothing I never did any change [16:39:02] SRvSaha: two spaces between py and arg [16:40:03] sanket: So is it 2 spaces after arg and description as well? [16:40:06] Roll Call :Himanshu sharma [16:40:26] Can we move to new thing? [16:40:42] kushal: yes [16:40:43] yes [16:40:44] ! [16:40:54] yes [16:40:58] ! [16:41:02] yes [16:41:09] yes [16:41:30] Roll call Anushil Kumar [16:41:36] SRvSaha: yes, if you still encounter issues, lets talk after class. [16:42:02] next [16:42:08] next [16:42:18] ;) [16:42:29] what was the last command you entered in terminal [16:43:10] what is it? https://shellshare.net/r/summertraining ? i did't understand. [16:43:12] akshays, less [16:43:19] There is no coding [16:43:21] was it less avik.rst ? [16:43:36] same question akshays ;) [16:43:39] buvanesh_kumar, yes, it is a live view of what I am doing [16:43:45] buvanesh_kumar, it is kushal terminal which he can share with shellshare. [16:43:45] akshays, yes [16:43:55] thanks :) [16:44:09] kushal [16:44:12] i known that thing. but inside the terminal content i did't understand [16:44:39] Okay [16:45:02] Can anyone tell me why are we learning about documentation first? [16:45:12] Even before we are learning to code [16:45:13] i am asking about avik.rst file contents kushal [16:45:25] buvanesh_kumar, he pasted that few minutes back [16:45:31] because great docs help in the long run, for others to see and maintain the code we write [16:45:42] kushal, because documentation helps us to easily read the code [16:45:49] Correct. [16:46:02] kushal: documentation is important and not as difficult as coding [16:46:06] But documentation is the way someone else will choose if they want to use the code you write or not/ [16:46:13] It helps to understand, kushal [16:46:25] Because it helps with getting started with project development [16:46:25] c0mrad3, it is important, but in times it comes as difficult as coding. [16:46:35] ! [16:46:41] Unless one understands the subject, that person can not do any documentation. [16:46:47] next [16:47:06] So, are we supposed to follow this form of documentation? [16:47:07] ! [16:47:45] akorep_, It is one way of doing it. [16:47:57] There are various styles, you can choose whatever you like. [16:48:01] next [16:48:11] hi kushal [16:48:16] ? [16:48:24] i am trying to implement grid table [16:48:28] kushal, thanks! [16:48:36] it is whowing line error [16:48:53] and while pasting it to pastebin it is getting messed up [16:48:58] the table structure [16:49:08] how can i show it to you?? [16:49:44] paste.fedoraproject.com pabitra [16:49:52] pabitra, ^^^ [16:50:07] mr-karan, did you read what i typed [16:50:09] kushal: you may probably add '.enter' command for batul that would trigger the same as: /msg fsbot enter [16:50:22] kushal: IMHO coding is a tough one than documentation, but I agree that one should understand the software for writing the documentation which is also a tough job [16:50:47] How to open .rst file by command [16:50:48] mr-karan, i am trying to paste it to there.. but on pasting it is getting messed up [16:51:12] c0mrad3, and then think about documentation of the development process or any new project, which can only be done by experienced people. [16:51:15] Rnarwade, vi test.rst [16:51:24] pabitra, still show us that one only [16:51:29] next [16:51:35] Onkar karale [16:51:35] Sry i am late [16:51:43] Onkar, what is Sry? [16:51:51] Onkar, is that Fry? [16:52:38] * c0mrad3 kushal I agree [16:52:53] next [16:52:57] Okay [16:52:59] Onkar: Fallow the etiqutte of IRC when chatting here. [16:53:20] So in the Python world we use a project/tool called sphinx to create the documentation [16:54:15] Today we will learn sphinx [16:54:17] ! [16:54:20] You can use it for most cases [16:54:23] HoloIRCUser is now known as jogi96_ [16:54:33] http://summertraining.readthedocs.io/en/latest/ this is done using sphinx [16:54:37] next [16:54:54] what is the difference between table and grid table [16:55:00] because both looks alike [16:55:14] ! [16:55:15] is only difference of spanned cells ?? [16:55:50] I think they are same, [16:56:00] the difference is in how you write them [16:56:01] next [16:56:04] kushal, python for you and me is written using sphinx ? [16:56:18] rahul_bajaj, yes [16:56:21] okay. [16:56:28] [16:57:13] The general idea is that we will have a docs directory inside any project, and we will create the documentation there [16:57:23] kushal, pabitra: isn't the other diff is that in grid cells, you can span multiple columns? [16:57:36] kushal, Can I leave now? I'll be back within half an hour. [16:57:42] akorep_, yes, you can [16:57:47] For today's class, we will call our project hellodgplug [16:58:05] thisisashwani, yes, the way you can put details on the table are different [16:58:32] kushal: okay! [16:58:39] thisisashwani, yes that's what i said... spanning across row and colummns [16:58:55] pabitra: oh, i missed that. [16:59:17] Look at the https://shellshare.net/r/summertraining [16:59:23] Everyone [17:00:07] looking [17:02:17] kushal: PS1='\w $ ' is better I think [17:02:40] anything happinging there? am i missing out ? [17:04:45] Wow, this link works on tablets :) [17:05:21] ! [17:05:33] Now everyone please look at this very carefully [17:05:34] next [17:05:42] http://paste.fedoraproject.org/385918/14671263/ [17:05:57] pabitra, can we please do this after the session? [17:05:57] sorry I missed the shellshare things [17:06:01] yeah sure [17:06:06] sorry [17:06:11] back to the shell [17:07:41] I enter n only to the last question [17:07:56] where I do not want to have the windows .bat file, but you can have that too [17:08:51] If your documentation needs to be build on windows, keep that to y [17:09:04] Now can everyone do the same on their computer [17:09:13] ? [17:09:20] ! [17:09:21] yes. [17:09:22] Done [17:09:23] next [17:09:40] ! [17:09:42] kushal: did you mention to install python-sphinx ? [17:09:52] c0mrad3, yes, but yesterday. [17:09:55] next [17:09:58] Root path?? [17:10:11] deep123k, just press Enter [17:10:27] ! [17:10:36] I missed yesterday [17:10:42] deep123k, you can scroll that webpage to see what happened [17:10:46] c0mrad3, Okay, [17:11:00] And what about name prefix for templates [17:11:01] c0mrad3, I have asked people to install that as the part of the session yesterday. [17:11:11] deep123k, just scroll the page and see [17:11:42] ! [17:12:05] next [17:12:09] sphinx- its not working in my shell [17:12:16] Rnarwade, what is the error? [17:12:18] next [17:12:25] is there any difference in installing packages using the disto manager (like dnf, apt) and using pip ? In respect of where and how the packages are installed ? [17:12:41] abstatic, Yes, there can be difference. [17:12:58] kushal, bash: sphinx-: command not found... [17:12:58] Failed to search for file: Failed to load repo fedora: error propagated from libsolv [17:13:24] Rnarwade, can you please see what is the command I gave? [17:13:31] Rnarwade, are you seeing this on a phone? [17:13:33] ! [17:13:48] Rnarwade, the command is sphinx-quickstart [17:13:50] next [17:13:56] ! [17:14:07] kushal, no [17:14:07] For source file suffix should I type .txt or .rst [17:14:55] ! [17:15:43] ! [17:15:47] next [17:15:50] kushal , Done [17:15:51] sphinx- is not working, it says sphinx- : command not found. I am using Ubuntu 15.10. [17:16:11] code_geek, can you please see the command I gave? [17:16:16] ! [17:16:29] code_geek, it is sphinx-quickstart [17:16:30] sorry, just saw Rnarwade's question [17:16:35] next [17:16:49] i got error while installing python-sphinx [17:17:06] https://paste.fedoraproject.org/385927/71269621/ [17:17:33] ! [17:18:14] akshays, strange [17:18:29] akshays, what is the output of which sphinx-quickstart ? [17:18:48] when i uses sphinx-quickstart command, it automatically prompted me to install sphinx .. akshays try that [17:19:42] but sphinx-quickstart does work [17:19:43] akshays: try doing sudo dnf upgrade and then installing using sudo dnf install python-sphinx [17:20:02] akshays, good for now. [17:20:04] next [17:20:09] kushal: i missed the first few things on your terminal, did you separate source and build directories? [17:20:29] kushal, i did all those steps... will it create a doc file ?? [17:21:30] thisisashwani, scroll it [17:21:31] pabitra, go to the directory and check yourself [17:21:36] you can scroll it up [17:21:58] yes... i checked... rohan_h only config and make files are present [17:22:00] pabitra, it will create many files [17:22:01] Next steps [17:22:28] pabitra: seriously, can it be scrolled, because i can't do it on my screen? [17:23:19] thisisashwani, i can scroll it ... [17:23:20] I'm getting error. i tried it into google. but i'm not getting. https://paste.fedoraproject.org/385930/27346146/ [17:23:22] I just added a chapter [17:23:26] c0mrad3, yes it is mentioned in the rst document [17:23:31] Now going to build the html [17:23:32] ! [17:23:51] ! [17:23:54] Now open the _build/html directory in your browser [17:23:55] next [17:24:31] ! [17:24:34] hi, it's now working for me :) [17:25:32] buvanesh_kumar, did you attend yesterdays session ? [17:25:44] next [17:26:06] nope :( rahul_bajaj [17:26:14] buvanesh_kumar, disable atrpms [17:26:22] next [17:26:29] Problem solved [17:26:34] next [17:26:35] disabled kushal Thanks [17:26:35] solved. [17:26:38] next [17:26:55] Now people feel free to go ahead and add new chapters to your docs [17:27:03] can u tell the command to create a new file in the sphinx [17:27:08] try out all the different rst things you know. [17:27:19] warlord77, What is u? [17:27:29] sorry it was you [17:27:29] * Richard15 you kushal [17:27:32] ! [17:28:07] ! [17:28:31] Richard15, ? [17:28:42] warlord77, I used vim to create a new file. [17:29:05] next [17:29:12] kushal: Should I first go to _build/toctrees and then do Make html ? I am getting this warning "/home/srvsaha/hellodgplug/docs/firstchapter.rst:: WARNING: document isn't included in any toctree" [17:29:23] ! [17:29:44] SRvSaha, see which directory I am in, also you have to add the firstchapter file in the index.rst [17:29:50] SRvSaha, watch the scrren [17:29:54] screen [17:30:15] After 3 spaces, I wrote the name of the file without the extension [17:30:31] 3 spaces. I gave 4 :( [17:31:02] so we have to keep our chapters in a separate doc folder ? [17:31:42] ! [17:32:04] SRvSaha, :) [17:32:08] Kushal : Can you please do it again from the beginning ? [17:32:26] I missed something [17:32:28] abstatic, no you have to keep them in the same directory with other docs files. [17:32:38] SRvSaha, what is the error are you getting? [17:32:43] I am getting warning : /home/srvsaha/hellodgplug/docs/index.rst:11: WARNING: toctree contains reference to document u'firstchapter' that doesn't have a title: no link will be generated [17:32:45] abstatic, check the terminal [17:33:01] kushal: Warning. No error [17:33:05] SRvSaha, yes, in the firstchapter.rst you do not have a title on the top [17:33:21] SRvSaha, look now [17:33:24] kushal, got it [17:33:56] Oh ok. Got it. Thanks Ku [17:33:59] kushal, can you do a ls command ? [17:34:20] abstatic, done [17:34:21] thank you. [17:34:53] Any more question on this ? [17:35:06] Other wise feel free to read and learn more from http://www.sphinx-doc.org/en/stable/ [17:35:25] We will meet tomorrow. [17:35:27] next [17:35:28] After creating firstchapter .rst how did you buils [17:35:37] deep123k, make html [17:35:39] next [17:35:41] ! [17:35:42] next [17:35:42] when i browse the index.html file, i don't see the link to the new chapter that i created. but i can access it manually. [17:35:53] ! [17:35:57] ! [17:35:57] solved [17:36:00] i also get the warning - /home/ubuntu/dev/coding/python/doctest/firstchapter.rst:: WARNING: document isn't included in any toctree [17:36:02] abstatic, yes, you are missing the chapter title on the top [17:36:05] please share the link to live terminal , i got disconnected and had to login from another computer [17:36:14] kushal: Thanks I am done. It's working fine now. [17:36:20] ! [17:36:20] abstatic, then you don't have it in the index.rst [17:36:22] next [17:36:26] how to create first chapter [17:36:35] kushal: Is the make file directly doing the work of rst2html ? [17:36:40] prashaant_, https://shellshare.net/r/summertraining [17:36:41] [17:36:49] kushal thanks i allways amazed how people can manage big Project documentation, and in couple of this lecture i came to know the secret :) [17:36:49] SRvSaha, sphinx is doing that work [17:37:02] amitk_, nothing secret in this :) [17:37:05] thanks kushal. [17:37:07] next [17:37:11] After creating firstchapter.rst how did you build [17:37:26] deep123k, scroll up, I gave the command [17:37:27] make html [17:37:28] next [17:37:39] akshays: vim firstchapter.rst [17:37:52] kushal, i found what i did wrong. I had slightly differnt file names in index.rst and the actual file created. renaming solved the problem! :) [17:37:52] next [17:37:52] kushal, to make it into html we have to use the same command as we used in rest [17:37:55] ! [17:38:09] ! [17:38:12] warlord77, give the following command [17:38:14] make html [17:38:14] next [17:38:51] next [17:39:01] Make html is giving error : no rule to make target 'html' [17:39:09] ! [17:39:14] deep123k, which directory are you in? [17:39:17] next [17:39:26] what to do after doing make html? [17:39:38] the files are in _build/html directory [17:39:40] how to view what we did? [17:39:41] kushal: Suppose I have 10 html files with 8 previously built using make. Now for the last 2, if I am doing make html, will all the html files be build or just the latest ones? [17:39:46] OPen your browser to view them [17:39:55] SRvSaha, try and see :) [17:40:02] avik, open firefox [17:40:02] ! [17:40:06] and then in my case [17:40:27] file:///home/fedora/hellodgplug/docs/_build/html [17:40:31] I open this path [17:40:32] next [17:40:35] We have to run the make html command every time we edit a project or create one? [17:40:44] code_geek, every time you update the docs [17:40:52] okay [17:40:52] code_geek, we can get it done automatically [17:40:58] we will learn about it later [17:41:06] okay :) [17:41:12] ! [17:41:14] cool [17:41:17] :) [17:41:21] If you see closely this docs already has a search engine for you. [17:41:22] next [17:41:50] i saw the index.html in browser but it doesnot look like the one you showed [17:42:26] akshays, I did not show you my index.html [17:42:52] i mean the dgplug python one [17:43:20] ! [17:43:29] akshays, yes, as it depends on the theme [17:43:34] they may look different [17:43:36] next [17:43:39] its just pain html page [17:43:48] ! [17:43:55] ! [17:44:01] akshays, may be you want to update your sphinx [17:44:01] next [17:44:02] we do need to understand each prompt of sphinx we passed by enter , right? [17:44:04] We have to convert firstproject.rst using rst2html command? Because I cannot find firstproject.html after make html. [17:44:16] avik, yes, but not right now [17:44:26] ok [17:44:28] code_geek, it is under _build/html [17:44:33] code_geek, see the terminal [17:44:48] code_geek, go to _build folder inside where you have the rst file [17:44:52] next [17:44:54] kushal: can you cat both the files in shellshare once [17:44:56] okay, thanks [17:45:12] c0mrad3, these two, correct? [17:45:19] yes [17:45:41] c0mrad3, is this okay? [17:45:45] kushal: yes [17:46:15] Okay [17:46:16] next [17:46:26] Good, have fun with sphinx [17:46:30] See you all tomorrow [17:46:34] Roll Call [17:46:36] ! [17:46:39] Akshay Shipurkar [17:46:39] Abhishek Shrivastava [17:46:40] Alakshendra Yadav [17:46:41] Tummala Dhanvi [17:46:42] Amit Kokitkar [17:46:42] Rohan Hazra [17:46:43] Vaibhav Jain [17:46:44] akshay cv [17:46:45] Yashwanth M [17:46:46] Suniva Priyadarshini [17:46:48] Mayank Gupta [17:46:50] Pabitra Pati [17:46:51] Deepanshu Kapoor [17:46:54] Dinesh [17:46:56] Moiz Sajid [17:46:56] Mahesh Gahlot [17:46:58] Aditya Bayana [17:46:59] Avik Mukherjee [17:47:00] Sudeep Mukherjee [17:47:03] poonam jadhav [17:47:08] Saurav Saha [17:47:09] Anushil Kumar [17:47:14] Jogender Kota [17:47:28] Akhilesh Dhaundiyal [17:47:32] Abheek [17:47:33] Sarah Masud [17:47:46] 26 people [17:47:48] Anupama Mandal [17:47:52] 27 [17:47:52] :) [17:48:04] See, only the interested people will continue the sessions. [17:48:17] Rhitik Bhatt [17:48:23] And if you continue, it will really help you in future :) [17:48:24] Varsha R [17:48:26] ! [17:48:28] next [17:48:30] next [17:48:40] Kushal what about LaTeX [17:48:48] ! [17:48:50] ! [17:48:51] ! [17:49:15] Shantanu Acharya [17:49:44] yASH, You can create latex from rst using sphinx [17:49:46] next [17:49:48] Do we have to create the index and firstchapter .rst page inside _build or is it okay to create outside of it? [17:50:04] real56, you don't have to create index.rst [17:50:10] see my directory [17:50:13] on the screen [17:50:20] shobhit upadhyay [17:50:24] ! [17:50:25] next [17:50:27] why can't i scroll in the live terminal? [17:50:29] kushal,can we make our document in any other format like pdf using sphinx? [17:50:41] mahesh5, yes, there is latexpdf [17:50:45] make latexpdf [17:50:46] sorry kushal, i missed the session today, i had appointment with doctor. Thanks, [17:50:57] but for that you need many latex packages installed. [17:51:03] chshbh, No problem [17:51:04] next [17:51:07] Kushal you did y for all except last two ..right? [17:52:00] Pasting here for logs [17:52:01] $ sphinx-quickstart [17:52:01] Welcome to the Sphinx 1.2.3 quickstart utility. [17:52:01] Please enter values for the following settings (just press Enter to [17:52:01] accept a default value, if one is given in brackets). [17:52:01] Enter the root path for documentation. [17:52:02] > Root path for the documentation [.]: [17:52:07] You have two options for placing the build directory for Sphinx output. [17:52:08] Either, you use a directory "_build" within the root path, or you separate [17:52:12] "source" and "build" directories within the root path. [17:52:14] > Separate source and build directories (y/n) [n]: [17:52:16] Inside the root directory, two more directories will be created; "_templates" [17:52:19] for custom HTML templates and "_static" for custom stylesheets and other static [17:52:20] files. You can enter another prefix (such as ".") to replace the underscore. [17:52:22] > Name prefix for templates and static dir [_]: [17:52:24] The project name will occur in several places in the built documentation. [17:52:28] > Project name: Our hello dgplug [17:52:30] > Author name(s): Kushal Das [17:52:32] Sphinx has the notion of a "version" and a "release" for the [17:52:36] software. Each version can have multiple releases. For example, for [17:52:38] Python the version is something like 2.5 or 3.0, while the release is [17:52:42] something like 2.5.1 or 3.0a1. If you don't need this dual structure, [17:52:44] just set both to the same value. [17:52:46] > Project version: 0.1 [17:52:48] > Project release [0.1]: [17:52:50] The file name suffix for source files. Commonly, this is either ".txt" [17:52:52] or ".rst". Only files with this suffix are considered documents. [17:52:54] > Source file suffix [.rst]: [17:52:58] One document is special in that it is considered the top node of the [17:53:00] "contents tree", that is, it is the root of the hierarchical structure [17:53:02] of the documents. Normally, this is "index", but if your "index" [17:53:06] document is a custom template, you can also set this to another filename. [17:53:08] > Name of your master document (without suffix) [index]: [17:53:12] Sphinx can also add configuration for epub output: [17:53:14] > Do you want to use the epub builder (y/n) [n]: [17:53:16] Please indicate if you want to use one of the following Sphinx extensions: [17:53:18] > autodoc: automatically insert docstri [17:53:21] Please indicate if you want to use one of the following Sphinx extensions: [17:53:22] > autodoc: automatically insert docstrings from modules (y/n) [n]: [17:53:24] > doctest: automatically test code snippets in doctest blocks (y/n) [n]: [17:53:28] > intersphinx: link between Sphinx documentation of different projects (y/n) [n]: [17:53:30] > todo: write "todo" entries that can be shown or hidden on build (y/n) [n]: [17:53:33] > coverage: checks for documentation coverage (y/n) [n]: [17:53:34] > pngmath: include math, rendered as PNG images (y/n) [n]: [17:53:39] > mathjax: include math, rendered in the browser by MathJax (y/n) [n]: [17:53:42] > ifconfig: conditional inclusion of content based on config values (y/n) [n]: [17:53:44] > viewcode: include links to the source code of documented Python objects (y/n) [n]: [17:53:46] A Makefile and a Windows command file can be generated for you so that you [17:53:48] only have to run e.g. `make html' instead of invoking sphinx-build [17:53:50] directly. [17:53:52] > Create Makefile? (y/n) [y]: [17:53:54] > Create Windows command file? (y/n) [y]: n [17:53:58] Creating file ./conf.py. [17:54:00] Creating file ./index.rst. [17:54:02] Creating file ./Makefile. [17:54:04] Finished: An initial directory structure has been created. [17:54:08] You should now populate your master file ./index.rst and create other documentation [17:54:12] source files. Use the Makefile to build the docs, like so: [17:54:15] make builder [17:54:16] where "builder" is one of the supported builders, e.g. html, latex or linkcheck. [17:54:18] and then do make html [17:54:20] for the rest ask help here from friends [17:54:22] You should try to help others, the easiest way to learn more. [17:54:24] See you all tomorrow [17:54:28] endclass [17:54:28] [## Class Ended at Tue Jun 28 17:54:28 2016 ##]