DOCSLIB.ORG

Sphinx Documentation Release

Total Page：16

File Type：pdf, Size：1020Kb

Download full-text PDF Read full-text
Sphinx Documentation Release Sphinx Documentation Release eagle Dec 14, 2017 Contents: 1 Installation 1 1.1 Prerequisites:...............................................1 2 New Project 3 3 Editor 5 4 Restructured Text 7 4.1 Create a new page:............................................7 4.2 Text Decorations:.............................................8 4.3 Lists:...................................................8 5 Indices and tables 11 i ii CHAPTER 1 Installation 1.1 Prerequisites: 1. python: download latest version of python and check the box to add python to environment path link 2. sphinx: after installing python install sphinx using the following command: pip install sphinx 3. read the docs theme: in the same manner install rtd theme pip install sphinx_rtd_theme 1 Sphinx Documentation, Release 2 Chapter 1. Installation CHAPTER 2 New Project In Command prompt run the following commands: //create a folder for the project: mkdir coding cd coding //start sphinx sphinx-quickstart //building the project make html //if using Visual Code integrated terminal ./make html 3 Sphinx Documentation, Release 4 Chapter 2. New Project CHAPTER 3 Editor • Install Visual Studio Code: Download • Right click on the project folder and choose to open with Code • Open conf.py and change the htm_theme to equal ‘sphinx_rtd_theme’ • Use the following code to build the project: ./make html • In Visual Code market place install reStructuredText • After reloading Code you can preview the pages by clicking the preview button at the top or by clicking Crt+k->r 5 Sphinx Documentation, Release 6 Chapter 3. Editor CHAPTER 4 Restructured Text 4.1 Create a new page: • To create a new Restructured page right click in project folder within visual code and choose to create a new file <file name>.rst • Add a reference to tha page in index.rst by adding the <file name> after :caption: Contents: by pressing enter twice and make sure you have three spaces from the beginning of the line. Note: Tap will not work because it will create four spaces 7 Sphinx Documentation, Release 4.2 Text Decorations: • To use italic use asterisk symbol between the required text, for bold user double asterisk and for code use two back `` ticks 4.3 Lists: • use * to make bulleted list • Use #. to make numbered list • To create sub list press tap at the beginning of a new line Cheat Sheet caution, danger, tip, note 8 Chapter 4. Restructured Text Sphinx Documentation, Release Supported languages Pygments supports an ever-growing range of languages. Watch this space... Programming lan- guages ActionScript Ada ANTLR AppleScript Assembly (various) Asymptote Awk Befunge Boo BrainFuck C, C++ C# Clojure CoffeeScript ColdFusion Common Lisp Coq Cryptol (incl. Literate Cryptol) Crystal Cython D Dart Delphi Dylan Elm Erlang Ezhil Ezhil - A Tamil programming language Factor Fancy Fortran F# GAP Gherkin (Cu- cumber) GL shaders Groovy Haskell (incl. Literate Haskell) IDL Io Java JavaScript Lasso LLVM Logtalk Lua Mat- lab MiniD Modelica Modula-2 MuPad Nemerle Nimrod Objective-C Objective-J Octave OCaml PHP Perl PovRay PostScript PowerShell Prolog Python 2.x and 3.x (incl. console sessions and tracebacks) REBOL Red Redcode Ruby (incl. irb sessions) Rust S, S-Plus, R Scala Scheme Scilab Smalltalk SNOBOL Tcl Vala Verilog VHDL Visual Ba- sic.NET Visual FoxPro XQuery Zephir Template languages Cheetah templates Django / Jinja templates ERB (Ruby templating) Genshi (the Trac template language) JSP (Java Server Pages) Myghty (the HTML::Mason based frame- work) Mako (the Myghty successor) Smarty templates (PHP templating) Tea Other markup Apache config files Bash shell scripts BBCode CMake CSS Debian control files Diff files DTD Gettext catalogs Gnuplot script Groff markup HTML HTTP sessions INI-style config files IRC logs (irssi style) Lighttpd config files Makefiles MoinMoin/Trac Wiki markup MySQL Nginx config files POV-Ray scenes Ragel Redcode ReST Robot Framework RPM spec files SQL, also MySQL, SQLite Squid configuration TeX tcsh Vim Script Windows batch files XML XSLT YAML pygments.org/languages/ 4.3. Lists: 9 Sphinx Documentation, Release 10 Chapter 4. Restructured Text CHAPTER 5 Indices and tables • genindex • modindex • search 11.
Load more

Recommended publications
  • IJIRT | Volume 2 Issue 6 | ISSN: 2349-6002
    © November 2015 | IJIRT | Volume 2 Issue 6 | ISSN: 2349-6002 .Net Surbhi Bhardwaj Dronacharya College of Engineering Khentawas, Haryana INTRODUCTION as smartphones. Additionally, .NET Micro .NET Framework (pronounced dot net) is Framework is targeted at severely resource- a software framework developed by Microsoft that constrained devices. runs primarily on Microsoft Windows. It includes a large class library known as Framework Class Library (FCL) and provides language WHAT IS THE .NET FRAMEWORK? interoperability(each language can use code written The .NET Framework is a new and revolutionary in other languages) across several programming platform created by Microsoft for languages. Programs written for .NET Framework developingapplications. execute in a software environment (as contrasted to hardware environment), known as Common It is a platform for application developers. Language Runtime (CLR), an application virtual It is a Framework that supports Multiple machine that provides services such as Language and Cross language integration. security, memory management, and exception handling. FCL and CLR together constitute .NET IT has IDE (Integrated Development Framework. Environment). FCL provides user interface, data access, database Framework is a set of utilities or can say connectivity, cryptography, web building blocks of your application system. application development, numeric algorithms, .NET Framework provides GUI in a GUI and network communications. Programmers manner. produce software by combining their own source code with .NET Framework and other libraries. .NET is a platform independent but with .NET Framework is intended to be used by most new help of Mono Compilation System (MCS). applications created for the Windows platform. MCS is a middle level interface. Microsoft also produces an integrated development .NET Framework provides interoperability environment largely for .NET software called Visual between languages i.e.
    [Show full text]
  • The Types, Roles, and Practices of Documentation in Data Analytics Open Source Software Libraries
    Computer Supported Cooperative Work (CSCW) https://doi.org/10.1007/s10606-018-9333-1 © The Author(s) 2018 The Types, Roles, and Practices of Documentation in Data Analytics Open Source Software Libraries A Collaborative Ethnography of Documentation Work R. Stuart Geiger1 , Nelle Varoquaux1,2 , Charlotte Mazel-Cabasse1 & Chris Holdgraf1,3 1Berkeley Institute for Data Science, University of California, Berkeley, 190 Doe Library, Berkeley, CA, 94730, USA (E-mail: [email protected]); 2Department of Statistics, Berkeley Institute for Data Science, University of California, Berkeley, Berkeley, CA, USA; 3Berkeley Institute for Data Science, Helen Wills Neuroscience Institute, University of California, Berkeley, Berkeley, CA, USA Abstract. Computational research and data analytics increasingly relies on complex ecosystems of open source software (OSS) “libraries” – curated collections of reusable code that programmers import to perform a specific task. Software documentation for these libraries is crucial in helping programmers/analysts know what libraries are available and how to use them. Yet documentation for open source software libraries is widely considered low-quality. This article is a collaboration between CSCW researchers and contributors to data analytics OSS libraries, based on ethnographic fieldwork and qualitative interviews. We examine several issues around the formats, practices, and challenges around documentation in these largely volunteer-based projects. There are many dif- ferent kinds and formats of documentation that exist around such libraries, which play a variety of educational, promotional, and organizational roles. The work behind documentation is similarly multifaceted, including writing, reviewing, maintaining, and organizing documentation. Different aspects of documentation work require contributors to have different sets of skills and overcome various social and technical barriers.
    [Show full text]
  • Manticore Search Documentation Release 3.0.2
    Manticore Search Documentation Release 3.0.2 The Manticore Search team Apr 01, 2021 Manticore Documentation 1 Introduction 1 2 Gettting Started 5 2.1 Getting started using Docker container.................................5 2.2 Getting Started using official packages................................. 10 2.3 Migrating from Manticore or Sphinx Search 2.x............................ 15 2.4 A guide on configuration file....................................... 17 2.5 A guide on connectivity......................................... 19 2.6 A guide on indexes............................................ 21 2.7 A guide on searching........................................... 24 3 Installation 31 3.1 Installing Manticore packages on Debian and Ubuntu.......................... 31 3.2 Installing Manticore packages on RedHat and CentOS......................... 32 3.3 Installing Manticore on Windows.................................... 33 3.4 Upgrading from Sphinx Search..................................... 34 3.5 Running Manticore Search in a Docker Container............................ 34 3.6 Compiling Manticore from source.................................... 35 3.7 Quick Manticore usage tour....................................... 38 4 Indexing 43 4.1 Indexes.................................................. 43 4.2 Data Types................................................ 47 4.3 Full-text fields.............................................. 49 4.4 Attributes................................................. 49 4.5 MVA (multi-valued attributes).....................................
    [Show full text]
  • Advanced Search Capabilities with Mysql and Sphinx
    Advanced search capabilities with MySQL and Sphinx Vladimir Fedorkov, Blackbird Andrew Aksyonoff, Sphinx Percona Live MySQL UC, 2014 Knock knock who’s there • Vladimir – Used Sphinx in production since 2006 – Performance geek – Blog http://astellar.com, twitter @vfedorkov – Works for Blackbird • Andrew – Created Sphinx, http://sphinxsearch.com – Just some random guy Search is important • This is 2014, Google spoiled everyone! • Search needs to exist • Search needs to be fast • Search needs to be relevant • Today, we aim to show you how to start – With Sphinx, obviously Available solutions • Most databases have integrated FT engines – MySQL (My and Inno), Postgres, MS SQL, Oracle… • Standalone solutions – Sphinx – Lucene / Solr – Lucene / ElasticSearch • Hosted services – IndexDen, SearchBox, Flying Sphinx, WebSolr, … Why Sphinx? • Built-in DB search sucks • Sphinx works great with DBs and MySQL • Sphinx talks SQL => zero learning curive • Fast, scalable, relevant, and other buzzwords :P • You probably heard about Lucene anyway • NEED MOAR DIVERSITY What Sphinx is not • Not a plugin to MySQL • Does not require MySQL • Not SQL-based (but we talk SQL) – Non-SQL APIs are available • Not a complete database replacement – Yet? – Ever! OLAP vs OLTP vs Column vs FTS vs Webscale Quick overview • Sphinx = standalone, open-source search server • Supports Real-time indexes • Fast – 10+ MB/sec/core indexing, 700+ qps/core searching – And counting! • Scalable – Can do a lot even on 1 box – Lets you aggregate search results from N boxes – Auto-sharding,
    [Show full text]
  • Sphinxql Query Builder Release 1.0.0
    SphinxQL Query Builder Release 1.0.0 Oct 12, 2018 Contents 1 Introduction 1 1.1 Compatiblity...............................................1 2 CHANGELOG 3 2.1 What’s New in 1.0.0...........................................3 3 Configuration 5 3.1 Obtaining a Connection.........................................5 3.2 Connection Parameters..........................................5 4 SphinxQL Query Builder 7 4.1 Creating a Query Builder Instance....................................7 4.2 Building a Query.............................................7 4.3 COMPILE................................................ 10 4.4 EXECUTE................................................ 10 5 Multi-Query Builder 13 6 Facets 15 7 Contribute 17 7.1 Pull Requests............................................... 17 7.2 Coding Style............................................... 17 7.3 Testing.................................................. 17 7.4 Issue Tracker............................................... 17 i ii CHAPTER 1 Introduction The SphinxQL Query Builder provides a simple abstraction and access layer which allows developers to generate SphinxQL statements which can be used to query an instance of the Sphinx search engine for results. 1.1 Compatiblity SphinxQL Query Builder is tested against the following environments: • PHP 5.6 and later • Sphinx (Stable) • Sphinx (Development) Note: It is recommended that you always use the latest stable version of Sphinx with the query builder. 1 SphinxQL Query Builder, Release 1.0.0 2 Chapter 1. Introduction CHAPTER 2 CHANGELOG 2.1 What’s New in 1.0.0 3 SphinxQL Query Builder, Release 1.0.0 4 Chapter 2. CHANGELOG CHAPTER 3 Configuration 3.1 Obtaining a Connection You can obtain a SphinxQL Connection with the Foolz\SphinxQL\Drivers\Mysqli\Connection class. <?php use Foolz\SphinxQL\Drivers\Mysqli\Connection; $conn= new Connection(); $conn->setparams(array('host' => '127.0.0.1', 'port' => 9306)); Warning: The existing PDO driver written is considered experimental as the behaviour changes between certain PHP releases.
    [Show full text]
  • Comparative Studies of Programming Languages; Course Lecture Notes
    Comparative Studies of Programming Languages, COMP6411 Lecture Notes, Revision 1.9 Joey Paquet Serguei A. Mokhov (Eds.) August 5, 2010 arXiv:1007.2123v6 [cs.PL] 4 Aug 2010 2 Preface Lecture notes for the Comparative Studies of Programming Languages course, COMP6411, taught at the Department of Computer Science and Software Engineering, Faculty of Engineering and Computer Science, Concordia University, Montreal, QC, Canada. These notes include a compiled book of primarily related articles from the Wikipedia, the Free Encyclopedia [24], as well as Comparative Programming Languages book [7] and other resources, including our own. The original notes were compiled by Dr. Paquet [14] 3 4 Contents 1 Brief History and Genealogy of Programming Languages 7 1.1 Introduction . 7 1.1.1 Subreferences . 7 1.2 History . 7 1.2.1 Pre-computer era . 7 1.2.2 Subreferences . 8 1.2.3 Early computer era . 8 1.2.4 Subreferences . 8 1.2.5 Modern/Structured programming languages . 9 1.3 References . 19 2 Programming Paradigms 21 2.1 Introduction . 21 2.2 History . 21 2.2.1 Low-level: binary, assembly . 21 2.2.2 Procedural programming . 22 2.2.3 Object-oriented programming . 23 2.2.4 Declarative programming . 27 3 Program Evaluation 33 3.1 Program analysis and translation phases . 33 3.1.1 Front end . 33 3.1.2 Back end . 34 3.2 Compilation vs. interpretation . 34 3.2.1 Compilation . 34 3.2.2 Interpretation . 36 3.2.3 Subreferences . 37 3.3 Type System . 38 3.3.1 Type checking . 38 3.4 Memory management .
    [Show full text]
  • { Type = Xmlpipe Xmlpipe Command = Perl /Path/To/Bin/Sphinxpipe2.Pl } Index Xmlpipe Source
    Setting up Sphinx ­ By Brett Estrade <[email protected]> http://www.justanswer.com/computer/expert­bestrade/ sphinx.conf: source example_xmlpipe_source { type = xmlpipe xmlpipe_command = perl /path/to/bin/sphinxpipe2.pl } index xmlpipe_source { src = example_xmlpipe_source path = /path/to/index_file_prefix docinfo = extern } command (assuming sphinxpipe2.pl outputs valid xmlpipe2 XML): indexer ­­config /path/to/sphinx.conf ­­all # creates indexes The above should just create the indexes. To set up the search server (searchd), the following needs to be added to the sphinx.conf: searchd { compat_sphinxql_magics = 0 listen = 192.168.0.2:9312 listen = 192.168.0.2:9306:mysql41 log = /path/to/searchd.log query_log = /path/to/query.log read_timeout = 30 max_children = 30 pid_file = /path/to/searchd.pid max_matches = 1000000 seamless_rotate = 1 preopen_indexes = 1 unlink_old = 1 workers = threads # for RT to work binlog_path = /path/to/sphinx_binlog } Assuming that searchd is running, the index command would require a “­­rotate” flag to read in the updated indexes whenever updated. indexer ­­rotate ­­config /path/to/sphinx.conf ­­all Searching Note that there is a MySQL compatible listening interface that is defined above using the “listen = 192.168.0.2:9306:mysql41” line. This means you can point a mysql client to “192.168.0.2:9306” and issue SELECT statements as described here: http://sphinxsearch.com/docs/archives/1.10/sphinxql.html Using the PHP Sphinx Client is covered starting at listing 12 of this article ­ http://www.ibm.com/developerworks/library/os­php­sphinxsearch/#list12 Note the difference between fields and attributes. Fields provide the text that is subject to the full text searching and indexing.
    [Show full text]
  • Diffsharp an AD Library for .NET Languages
    DiffSharp An AD Library for .NET Languages Atılım Güneş Baydin1 Barak A. Pearlmutter2 Jeffrey Mark Siskind3 1University of Oxford [email protected] 2Maynooth University [email protected] 3Purdue University [email protected] http://www.robots.ox.ac.uk/~gunes/ AD2016, September 13, 2016 The .NET “ecosystem” Languages The main .NET languages: C#, F#, VB, C++/CLI Around 30 other (somewhat obscure) languages: F*, Eiffel, A#, ClojureCLR, IronPython, Nemerle, ... https://en.wikipedia.org/wiki/List_of_CLI_languages 1/18 C# Stack Overflow Developer Survey 2015 TIOBE Index, September 2016 http://stackoverflow.com/research/developer-survey-2015 http://www.tiobe.com/tiobe-index/ 2/18 F# An OCaml-based, strongly-typed, functional language, used in computational finance, machine learning Allows us to expose AD as a higher-order API accept first class functions as arguments return derivative functions, which can be arbitrarily nested //A scalar-to-scalar function let f x = sin (sqrt x) //2nd derivative off let f’’ = diff (diff f) // Evaluatef’’ at2 let d = f’’ 2. 3/18 Runtimes Previously: .NET Framework (Windows) and Mono (Linux, Mac OS) Since 27 June 2016: .NET Core 1.0 https://dotnet.github.io/ Open-source (MIT License) Cross-platform (Linux, Mac OS, Windows) 4/18 DiffSharp DiffSharp http://diffsharp.github.io/DiffSharp Deeply-embedded, higher-order, forward and reverse AD Support for nesting, currying High-performance matrix operations (using BLAS/LAPACK/CUDA) Implemented in F#, usable by all .NET languages (helper interface for C# and other procedural
    [Show full text]
  • Sphinx As a Tool for Documenting Technical Projects 1
    SPHINX AS A TOOL FOR DOCUMENTING TECHNICAL PROJECTS 1 Sphinx as a Tool for Documenting Technical Projects Javier García-Tobar Abstract—Documentation is a vital part of a technical project, yet is sometimes overlooked because of its time-consuming nature. A successful documentation system can therefore benefit relevant organizations and individuals. The focus of this paper is to summarize the main features of Sphinx: an open-source tool created to generate Python documentation formatted into standard files (HTML, PDF and ePub). Based on its results, this research recommends the use of Sphinx for the more efficient writing and managing of a project’s technical documentation. Keywords—project, documentation, Python, Sphinx. —————————— —————————— 1 INTRODUCTION In a technologically advanced and fast-paced modern socie- tation is encouraged in the field of programming because it ty, computer-stored data is found in immense quantities. gives the programmer a copy of their previous work. Fur- Writers, researchers, journalists and teachers – to name but a thermore, it helps other programmers to modify their coding, few relevant fields – have acknowledged the issue of and it benefits the pooling of information within an organi- dealing with ever-increasing quantities of data. The data can zation. appear in many forms. Therefore, most computer-literate, Software documentation should be focused on transmit- modern professionals welcome software (or hardware) that ting information that is useful and meaningful rather than aids them in managing and collating substantial amounts of information that is precise and exact (Forward and Leth- data formats. bridge, 2002). Software tools are used to document a pro- All technical projects produce a large quantity of docu- gram’s source code.
    [Show full text]
  • Introduction to .NET, C#, and Visual Studio
    Introduction to .NET, C#, and Visual Studio C# Programming January 8 Part I Administrivia Administrivia • When: Wednesdays 10–11am (and a few Mondays as needed) • Where: Moore 100B • This lab has Windows machines, but feel free to bring laptops • Office Hours: to be announced • Course webpage: http://www.seas.upenn.edu/~cse39905 Course Structure • No quizzes, no exams • Roughly 6 projects • Roughly 2 weeks per project • The final project will be slightly longer and more open-ended • Projects will be due at midnight on the night of the deadline • All assignments should be submitted through the Blackboard Digital Dropbox • Late policy: 15% off each day, up to 3 days late Final Project • Your chance to choose your own project • Brainstorming and planning will begin after spring break • Top projects will be entered into the Xtreme.NET Challenge – hopefully there will be 20 top projects :-) • First prize: Xbox 360! • Judges will include someone from Microsoft recruiting, maybe someone from the C# team • More details to come at http://www.seas.upenn.edu/~cse39905/xtreme Part II What is .NET? The Microsoft .NET Framework • .NET is a development platform that launched in 2000 • Goals include language independence, language integration, web services • Technologies to promote rapid development of secure, connected applications • .NET components include: • Languages (C#, VB, Visual C++, Visual J#, ...) • Common Language Runtime (CLR) • Framework Class Library (FCL) Common Language Runtime • A single runtime environment to execute programs written in any .NET language • Includes a virtual machine • Activates objects, manages memory, performs security checks, collects garbage • To run on the CLR, a language must adhere to a Common Language Specification (CLS) • A language must also build upon base types specified in the Common Type System (CTS) Languages • Language compilers translate source into Microsoft Intermediate Language (MSIL).
    [Show full text]
  • Comparative Studies of Six Programming Languages
    Comparative Studies of Six Programming Languages Zakaria Alomari Oualid El Halimi Kaushik Sivaprasad Chitrang Pandit Concordia University Concordia University Concordia University Concordia University Montreal, Canada Montreal, Canada Montreal, Canada Montreal, Canada [email protected] [email protected] [email protected] [email protected] Abstract Comparison of programming languages is a common topic of discussion among software engineers. Multiple programming languages are designed, specified, and implemented every year in order to keep up with the changing programming paradigms, hardware evolution, etc. In this paper we present a comparative study between six programming languages: C++, PHP, C#, Java, Python, VB ; These languages are compared under the characteristics of reusability, reliability, portability, availability of compilers and tools, readability, efficiency, familiarity and expressiveness. 1. Introduction: Programming languages are fascinating and interesting field of study. Computer scientists tend to create new programming language. Thousand different languages have been created in the last few years. Some languages enjoy wide popularity and others introduce new features. Each language has its advantages and drawbacks. The present work provides a comparison of various properties, paradigms, and features used by a couple of popular programming languages: C++, PHP, C#, Java, Python, VB. With these variety of languages and their widespread use, software designer and programmers should to be aware
    [Show full text]
  • Working-With-Mediawiki-Yaron-Koren.Pdf
    Working with MediaWiki Yaron Koren 2 Working with MediaWiki by Yaron Koren Published by WikiWorks Press. Copyright ©2012 by Yaron Koren, except where otherwise noted. Chapter 17, “Semantic Forms”, includes significant content from the Semantic Forms homepage (https://www. mediawiki.org/wiki/Extension:Semantic_Forms), available under the Creative Commons BY-SA 3.0 license. All rights reserved. Library of Congress Control Number: 2012952489 ISBN: 978-0615720302 First edition, second printing: 2014 Ordering information for this book can be found at: http://workingwithmediawiki.com All printing of this book is handled by CreateSpace (https://createspace.com), a subsidiary of Amazon.com. Cover design by Grace Cheong (http://gracecheong.com). Contents 1 About MediaWiki 1 History of MediaWiki . 1 Community and support . 3 Available hosts . 4 2 Setting up MediaWiki 7 The MediaWiki environment . 7 Download . 7 Installing . 8 Setting the logo . 8 Changing the URL structure . 9 Updating MediaWiki . 9 3 Editing in MediaWiki 11 Tabs........................................................... 11 Creating and editing pages . 12 Page history . 14 Page diffs . 15 Undoing . 16 Blocking and rollbacks . 17 Deleting revisions . 17 Moving pages . 18 Deleting pages . 19 Edit conflicts . 20 4 MediaWiki syntax 21 Wikitext . 21 Interwiki links . 26 Including HTML . 26 Templates . 27 3 4 Contents Parser and tag functions . 30 Variables . 33 Behavior switches . 33 5 Content organization 35 Categories . 35 Namespaces . 38 Redirects . 41 Subpages and super-pages . 42 Special pages . 43 6 Communication 45 Talk pages . 45 LiquidThreads . 47 Echo & Flow . 48 Handling reader comments . 48 Chat........................................................... 49 Emailing users . 49 7 Images and files 51 Uploading . 51 Displaying images . 55 Image galleries .
    [Show full text]