Hacky documentation website search using either Perl or Python











up vote
1
down vote

favorite












I have a test coming up where we have been provided full access to perl5 and python3 documentation. The problem the search feature in these documentations have been disabled as I guess it uses the internet to get results.[Exam environment, the internet is disabled]



I was hoping if I could write a hacky/ make-shift website documentation search to use during the exam.[I will learn and reproduce the code in exam and then use it NOT carry it on a device or something]



All the resources available online either reference external libraries or implement sophisticated ranking searches. Which is not practical for my purpose.



Details:




  1. The documentation is hosted on the university domain

  2. I have access to Perl5, Python3.6, python2.7, Vanilla JS


Requirement:




  1. Search website for the keyword

  2. display links based on the frequency of the said keyword


I would appreciate if you could point me to appropriate resources or give advice as to how to approach this.



EDIT 1:
I am on some sort of a private network. So WGET works to pull the website but links pointing to external download sources are disabled, I can only access links that point to locations within the docs.



EDIT 2:
I ended up using perldocs had a hard time looking for stuff but it was better than alternatives and best available.










share|improve this question




















  • 1




    Note that you can use perldoc and pydoc from the command line. However, some Perl installations omit the documentation, and pydoc is only a frontend for the help() system – it only shows the docstrings and introspects the structure of modules/classes, but does not show the full documentation.
    – amon
    Nov 11 at 10:57






  • 1




    perldoc command line tool gives access to Perl docs. Depending on command-line options, it can bring up specific perl doc pages, docs on modules, specific functions or special vars.
    – ikegami
    Nov 11 at 19:59















up vote
1
down vote

favorite












I have a test coming up where we have been provided full access to perl5 and python3 documentation. The problem the search feature in these documentations have been disabled as I guess it uses the internet to get results.[Exam environment, the internet is disabled]



I was hoping if I could write a hacky/ make-shift website documentation search to use during the exam.[I will learn and reproduce the code in exam and then use it NOT carry it on a device or something]



All the resources available online either reference external libraries or implement sophisticated ranking searches. Which is not practical for my purpose.



Details:




  1. The documentation is hosted on the university domain

  2. I have access to Perl5, Python3.6, python2.7, Vanilla JS


Requirement:




  1. Search website for the keyword

  2. display links based on the frequency of the said keyword


I would appreciate if you could point me to appropriate resources or give advice as to how to approach this.



EDIT 1:
I am on some sort of a private network. So WGET works to pull the website but links pointing to external download sources are disabled, I can only access links that point to locations within the docs.



EDIT 2:
I ended up using perldocs had a hard time looking for stuff but it was better than alternatives and best available.










share|improve this question




















  • 1




    Note that you can use perldoc and pydoc from the command line. However, some Perl installations omit the documentation, and pydoc is only a frontend for the help() system – it only shows the docstrings and introspects the structure of modules/classes, but does not show the full documentation.
    – amon
    Nov 11 at 10:57






  • 1




    perldoc command line tool gives access to Perl docs. Depending on command-line options, it can bring up specific perl doc pages, docs on modules, specific functions or special vars.
    – ikegami
    Nov 11 at 19:59













up vote
1
down vote

favorite









up vote
1
down vote

favorite











I have a test coming up where we have been provided full access to perl5 and python3 documentation. The problem the search feature in these documentations have been disabled as I guess it uses the internet to get results.[Exam environment, the internet is disabled]



I was hoping if I could write a hacky/ make-shift website documentation search to use during the exam.[I will learn and reproduce the code in exam and then use it NOT carry it on a device or something]



All the resources available online either reference external libraries or implement sophisticated ranking searches. Which is not practical for my purpose.



Details:




  1. The documentation is hosted on the university domain

  2. I have access to Perl5, Python3.6, python2.7, Vanilla JS


Requirement:




  1. Search website for the keyword

  2. display links based on the frequency of the said keyword


I would appreciate if you could point me to appropriate resources or give advice as to how to approach this.



EDIT 1:
I am on some sort of a private network. So WGET works to pull the website but links pointing to external download sources are disabled, I can only access links that point to locations within the docs.



EDIT 2:
I ended up using perldocs had a hard time looking for stuff but it was better than alternatives and best available.










share|improve this question















I have a test coming up where we have been provided full access to perl5 and python3 documentation. The problem the search feature in these documentations have been disabled as I guess it uses the internet to get results.[Exam environment, the internet is disabled]



I was hoping if I could write a hacky/ make-shift website documentation search to use during the exam.[I will learn and reproduce the code in exam and then use it NOT carry it on a device or something]



All the resources available online either reference external libraries or implement sophisticated ranking searches. Which is not practical for my purpose.



Details:




  1. The documentation is hosted on the university domain

  2. I have access to Perl5, Python3.6, python2.7, Vanilla JS


Requirement:




  1. Search website for the keyword

  2. display links based on the frequency of the said keyword


I would appreciate if you could point me to appropriate resources or give advice as to how to approach this.



EDIT 1:
I am on some sort of a private network. So WGET works to pull the website but links pointing to external download sources are disabled, I can only access links that point to locations within the docs.



EDIT 2:
I ended up using perldocs had a hard time looking for stuff but it was better than alternatives and best available.







javascript python perl web search






share|improve this question















share|improve this question













share|improve this question




share|improve this question








edited Nov 17 at 7:03

























asked Nov 11 at 7:55









cRAYonhere

258




258








  • 1




    Note that you can use perldoc and pydoc from the command line. However, some Perl installations omit the documentation, and pydoc is only a frontend for the help() system – it only shows the docstrings and introspects the structure of modules/classes, but does not show the full documentation.
    – amon
    Nov 11 at 10:57






  • 1




    perldoc command line tool gives access to Perl docs. Depending on command-line options, it can bring up specific perl doc pages, docs on modules, specific functions or special vars.
    – ikegami
    Nov 11 at 19:59














  • 1




    Note that you can use perldoc and pydoc from the command line. However, some Perl installations omit the documentation, and pydoc is only a frontend for the help() system – it only shows the docstrings and introspects the structure of modules/classes, but does not show the full documentation.
    – amon
    Nov 11 at 10:57






  • 1




    perldoc command line tool gives access to Perl docs. Depending on command-line options, it can bring up specific perl doc pages, docs on modules, specific functions or special vars.
    – ikegami
    Nov 11 at 19:59








1




1




Note that you can use perldoc and pydoc from the command line. However, some Perl installations omit the documentation, and pydoc is only a frontend for the help() system – it only shows the docstrings and introspects the structure of modules/classes, but does not show the full documentation.
– amon
Nov 11 at 10:57




Note that you can use perldoc and pydoc from the command line. However, some Perl installations omit the documentation, and pydoc is only a frontend for the help() system – it only shows the docstrings and introspects the structure of modules/classes, but does not show the full documentation.
– amon
Nov 11 at 10:57




1




1




perldoc command line tool gives access to Perl docs. Depending on command-line options, it can bring up specific perl doc pages, docs on modules, specific functions or special vars.
– ikegami
Nov 11 at 19:59




perldoc command line tool gives access to Perl docs. Depending on command-line options, it can bring up specific perl doc pages, docs on modules, specific functions or special vars.
– ikegami
Nov 11 at 19:59












2 Answers
2






active

oldest

votes

















up vote
0
down vote













Why don't you build the docs yourself with sphinx?



Just take python repo https://github.com/python/cpython/tree/master/Doc and run the sphinx, then you can also apply any theme you like: python-docs-theme, rtd-theme.






share|improve this answer





















  • I will get the copy on docs during the exam. I cannot take material into the exam.
    – cRAYonhere
    Nov 11 at 9:03










  • You should also be able to rebuilt the docs from sources because sphinx web contains it's sources in _sources eg: docs.python.org/3/_sources
    – oglop
    Nov 14 at 6:00


















up vote
0
down vote













I think the best way for you would be to download the docs for offline use;



https://docs.python.org/3.6/archives/python-3.6.7-docs-html.zip



You can then search the documentation offline aswell.






share|improve this answer





















  • Download option has been blocked. I can do wget and stuff no internet access and since the link you provided is hosted outside, I don't have access to it.
    – cRAYonhere
    Nov 11 at 9:02












  • how can you "do wget and stuff " without internet access?
    – Jack Herer
    Nov 11 at 9:15










  • what does "Download option has been blocked" mean?
    – Jack Herer
    Nov 11 at 9:15










  • can you not just download the html docs then just upload the docs to the uni domain?
    – Jack Herer
    Nov 11 at 9:17






  • 1




    You could learn a basic implementation of... zackgrossbart.com/hackito/search-engine-python
    – Jack Herer
    Nov 11 at 9:22











Your Answer






StackExchange.ifUsing("editor", function () {
StackExchange.using("externalEditor", function () {
StackExchange.using("snippets", function () {
StackExchange.snippets.init();
});
});
}, "code-snippets");

StackExchange.ready(function() {
var channelOptions = {
tags: "".split(" "),
id: "1"
};
initTagRenderer("".split(" "), "".split(" "), channelOptions);

StackExchange.using("externalEditor", function() {
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled) {
StackExchange.using("snippets", function() {
createEditor();
});
}
else {
createEditor();
}
});

function createEditor() {
StackExchange.prepareEditor({
heartbeatType: 'answer',
convertImagesToLinks: true,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: 10,
bindNavPrevention: true,
postfix: "",
imageUploader: {
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
},
onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
});


}
});














draft saved

draft discarded


















StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53246828%2fhacky-documentation-website-search-using-either-perl-or-python%23new-answer', 'question_page');
}
);

Post as a guest















Required, but never shown

























2 Answers
2






active

oldest

votes








2 Answers
2






active

oldest

votes









active

oldest

votes






active

oldest

votes








up vote
0
down vote













Why don't you build the docs yourself with sphinx?



Just take python repo https://github.com/python/cpython/tree/master/Doc and run the sphinx, then you can also apply any theme you like: python-docs-theme, rtd-theme.






share|improve this answer





















  • I will get the copy on docs during the exam. I cannot take material into the exam.
    – cRAYonhere
    Nov 11 at 9:03










  • You should also be able to rebuilt the docs from sources because sphinx web contains it's sources in _sources eg: docs.python.org/3/_sources
    – oglop
    Nov 14 at 6:00















up vote
0
down vote













Why don't you build the docs yourself with sphinx?



Just take python repo https://github.com/python/cpython/tree/master/Doc and run the sphinx, then you can also apply any theme you like: python-docs-theme, rtd-theme.






share|improve this answer





















  • I will get the copy on docs during the exam. I cannot take material into the exam.
    – cRAYonhere
    Nov 11 at 9:03










  • You should also be able to rebuilt the docs from sources because sphinx web contains it's sources in _sources eg: docs.python.org/3/_sources
    – oglop
    Nov 14 at 6:00













up vote
0
down vote










up vote
0
down vote









Why don't you build the docs yourself with sphinx?



Just take python repo https://github.com/python/cpython/tree/master/Doc and run the sphinx, then you can also apply any theme you like: python-docs-theme, rtd-theme.






share|improve this answer












Why don't you build the docs yourself with sphinx?



Just take python repo https://github.com/python/cpython/tree/master/Doc and run the sphinx, then you can also apply any theme you like: python-docs-theme, rtd-theme.







share|improve this answer












share|improve this answer



share|improve this answer










answered Nov 11 at 8:11









oglop

668




668












  • I will get the copy on docs during the exam. I cannot take material into the exam.
    – cRAYonhere
    Nov 11 at 9:03










  • You should also be able to rebuilt the docs from sources because sphinx web contains it's sources in _sources eg: docs.python.org/3/_sources
    – oglop
    Nov 14 at 6:00


















  • I will get the copy on docs during the exam. I cannot take material into the exam.
    – cRAYonhere
    Nov 11 at 9:03










  • You should also be able to rebuilt the docs from sources because sphinx web contains it's sources in _sources eg: docs.python.org/3/_sources
    – oglop
    Nov 14 at 6:00
















I will get the copy on docs during the exam. I cannot take material into the exam.
– cRAYonhere
Nov 11 at 9:03




I will get the copy on docs during the exam. I cannot take material into the exam.
– cRAYonhere
Nov 11 at 9:03












You should also be able to rebuilt the docs from sources because sphinx web contains it's sources in _sources eg: docs.python.org/3/_sources
– oglop
Nov 14 at 6:00




You should also be able to rebuilt the docs from sources because sphinx web contains it's sources in _sources eg: docs.python.org/3/_sources
– oglop
Nov 14 at 6:00












up vote
0
down vote













I think the best way for you would be to download the docs for offline use;



https://docs.python.org/3.6/archives/python-3.6.7-docs-html.zip



You can then search the documentation offline aswell.






share|improve this answer





















  • Download option has been blocked. I can do wget and stuff no internet access and since the link you provided is hosted outside, I don't have access to it.
    – cRAYonhere
    Nov 11 at 9:02












  • how can you "do wget and stuff " without internet access?
    – Jack Herer
    Nov 11 at 9:15










  • what does "Download option has been blocked" mean?
    – Jack Herer
    Nov 11 at 9:15










  • can you not just download the html docs then just upload the docs to the uni domain?
    – Jack Herer
    Nov 11 at 9:17






  • 1




    You could learn a basic implementation of... zackgrossbart.com/hackito/search-engine-python
    – Jack Herer
    Nov 11 at 9:22















up vote
0
down vote













I think the best way for you would be to download the docs for offline use;



https://docs.python.org/3.6/archives/python-3.6.7-docs-html.zip



You can then search the documentation offline aswell.






share|improve this answer





















  • Download option has been blocked. I can do wget and stuff no internet access and since the link you provided is hosted outside, I don't have access to it.
    – cRAYonhere
    Nov 11 at 9:02












  • how can you "do wget and stuff " without internet access?
    – Jack Herer
    Nov 11 at 9:15










  • what does "Download option has been blocked" mean?
    – Jack Herer
    Nov 11 at 9:15










  • can you not just download the html docs then just upload the docs to the uni domain?
    – Jack Herer
    Nov 11 at 9:17






  • 1




    You could learn a basic implementation of... zackgrossbart.com/hackito/search-engine-python
    – Jack Herer
    Nov 11 at 9:22













up vote
0
down vote










up vote
0
down vote









I think the best way for you would be to download the docs for offline use;



https://docs.python.org/3.6/archives/python-3.6.7-docs-html.zip



You can then search the documentation offline aswell.






share|improve this answer












I think the best way for you would be to download the docs for offline use;



https://docs.python.org/3.6/archives/python-3.6.7-docs-html.zip



You can then search the documentation offline aswell.







share|improve this answer












share|improve this answer



share|improve this answer










answered Nov 11 at 8:35









Jack Herer

319111




319111












  • Download option has been blocked. I can do wget and stuff no internet access and since the link you provided is hosted outside, I don't have access to it.
    – cRAYonhere
    Nov 11 at 9:02












  • how can you "do wget and stuff " without internet access?
    – Jack Herer
    Nov 11 at 9:15










  • what does "Download option has been blocked" mean?
    – Jack Herer
    Nov 11 at 9:15










  • can you not just download the html docs then just upload the docs to the uni domain?
    – Jack Herer
    Nov 11 at 9:17






  • 1




    You could learn a basic implementation of... zackgrossbart.com/hackito/search-engine-python
    – Jack Herer
    Nov 11 at 9:22


















  • Download option has been blocked. I can do wget and stuff no internet access and since the link you provided is hosted outside, I don't have access to it.
    – cRAYonhere
    Nov 11 at 9:02












  • how can you "do wget and stuff " without internet access?
    – Jack Herer
    Nov 11 at 9:15










  • what does "Download option has been blocked" mean?
    – Jack Herer
    Nov 11 at 9:15










  • can you not just download the html docs then just upload the docs to the uni domain?
    – Jack Herer
    Nov 11 at 9:17






  • 1




    You could learn a basic implementation of... zackgrossbart.com/hackito/search-engine-python
    – Jack Herer
    Nov 11 at 9:22
















Download option has been blocked. I can do wget and stuff no internet access and since the link you provided is hosted outside, I don't have access to it.
– cRAYonhere
Nov 11 at 9:02






Download option has been blocked. I can do wget and stuff no internet access and since the link you provided is hosted outside, I don't have access to it.
– cRAYonhere
Nov 11 at 9:02














how can you "do wget and stuff " without internet access?
– Jack Herer
Nov 11 at 9:15




how can you "do wget and stuff " without internet access?
– Jack Herer
Nov 11 at 9:15












what does "Download option has been blocked" mean?
– Jack Herer
Nov 11 at 9:15




what does "Download option has been blocked" mean?
– Jack Herer
Nov 11 at 9:15












can you not just download the html docs then just upload the docs to the uni domain?
– Jack Herer
Nov 11 at 9:17




can you not just download the html docs then just upload the docs to the uni domain?
– Jack Herer
Nov 11 at 9:17




1




1




You could learn a basic implementation of... zackgrossbart.com/hackito/search-engine-python
– Jack Herer
Nov 11 at 9:22




You could learn a basic implementation of... zackgrossbart.com/hackito/search-engine-python
– Jack Herer
Nov 11 at 9:22


















draft saved

draft discarded




















































Thanks for contributing an answer to Stack Overflow!


  • Please be sure to answer the question. Provide details and share your research!

But avoid



  • Asking for help, clarification, or responding to other answers.

  • Making statements based on opinion; back them up with references or personal experience.


To learn more, see our tips on writing great answers.





Some of your past answers have not been well-received, and you're in danger of being blocked from answering.


Please pay close attention to the following guidance:


  • Please be sure to answer the question. Provide details and share your research!

But avoid



  • Asking for help, clarification, or responding to other answers.

  • Making statements based on opinion; back them up with references or personal experience.


To learn more, see our tips on writing great answers.




draft saved


draft discarded














StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53246828%2fhacky-documentation-website-search-using-either-perl-or-python%23new-answer', 'question_page');
}
);

Post as a guest















Required, but never shown





















































Required, but never shown














Required, but never shown












Required, but never shown







Required, but never shown

































Required, but never shown














Required, but never shown












Required, but never shown







Required, but never shown







Popular posts from this blog

Full-time equivalent

Bicuculline

さくらももこ