Fix documentation
See original GitHub issueThe documentation needs to be fixed.
Currently, Sphinx throws lots of errors and warnings and the generated HTML is missing parts and even whole pages. It also looks like files are getting duplicated now (maybe due to changes in how Sphinx does things?): newly generated sources have .rst.txt
as file extension, but files with the same contents already exist with a .txt
extension. (These files are saved in the _sources
dir of the generated docs.)
As far as I can tell, Sphinx is supposed to incorporate the docstrings of certain classes/methods on some pages, and that is currently failing, so I’m guessing these “includes” aren’t referenced correctly (anymore).
Issue Analytics
- State:
- Created 7 years ago
- Comments:5 (1 by maintainers)
Top Results From Across the Web
FIX Standards • FIX Trading Community v1.8
“SPECIFICATION” takes you to the latest Release Candidate (or final specification) of the latest version. “DOWNLOADS” takes you to a page from where...
Read more >FIX 4.2: Fields by Tag – FIX Dictionary - OnixS
FIX 4.2: Fields by Tag – FIX Dictionary – Onix Solutions.
Read more >FIX API Specifications - FXCM API Developer Documentation
FIX API using FIX Protocol 4.4 is designed for real-time, custom institutional interface which can push up to ... Request documentation by signing...
Read more >Documentation | FIX API - TraderMade
Data Documentation for FIX Protocol API, includes detailed Python and Java examples for easy integration.
Read more >Financial Information eXchange (FIX)
This document describes the Financial Information eXchange (FIX) interface for trading equities with DriveWealth, LLC using Version 4.2 of the FIX Protocol ...
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
@flothesof Oh, I knew how to do it alright. But the docs are broken.
And yeah, the idea of adding a
CONTRIBUTING.md
file to the repo in the future is floating around, and there’s also a Wiki (or the beginnings of a Wiki). Though I think we should fix the docs first before making people aware of how they could theoretically contribute.The instructions at https://github.com/Zulko/moviepy#documentation are:
These worked fine for me, and output the result in docs/build/html. Then all that is required is copying that into the
gh-pages
branch (this could definitely be streamlined further).