$30 off During Our Annual Pro Sale. View Details »

Sa’im al-Dahr: Run Sphinx doctests with Nose

Sa’im al-Dahr: Run Sphinx doctests with Nose

Sa’im al-Dahr finds the missing nose of the Sphinx. Actually a Nose plugin that reads in Sphinx doctests, and run them as Nose test cases.

Tzu-ping Chung

February 26, 2015
Tweet

More Decks by Tzu-ping Chung

Other Decks in Programming

Transcript

  1. Sa’im al-Dahr

    View Slide

  2. The Great
    Sphinx of Giza

    View Slide

  3. View Slide

  4. View Slide

  5. View Slide

  6. View Slide

  7. Sphinx + Nose = ?

    View Slide

  8. Sa’im al-Dahr

    View Slide

  9. Why?
    • One-stop testing
    • Code in docs should be tested
    • Some tests shouldn’t be in docs

    View Slide

  10. pip  install  sphinx-­‐nose

    View Slide

  11. View Slide

  12. View Slide

  13. $  nosetests  -­‐-­‐with-­‐sphinx  
    ...............  
    -­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐  
    Ran  15  tests  in  0.022s  
    OK

    View Slide

  14. import  nose  
    from  sphinxnose  import  SphinxDoctest  
    def  runtests():  
         nose.run(  
                   argv=[  
                           __file__,  
                           '-­‐-­‐with-­‐sphinx',  
                           '-­‐-­‐sphinx-­‐doc-­‐dir=testdocs'  
                   ],  
                   plugins=[SphinxDoctest()],  
           )

    View Slide

  15. http://github.com/
    uranusjr/saim-­‐al-­‐dahr

    View Slide

  16. WHAT IF I AM INTERESTED
    IN SOMETHING ELSE?

    View Slide