reference.rst 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  1. API Reference (in progress)
  2. ***************************
  3. **NOTE: This page is still a work in progress... We need to go through our
  4. docstrings and make them sphinx-compliant, and figure out how to improve
  5. formatting with the sphinx-bootstrap-theme plugin. Pull requests would be
  6. very welcome.**
  7. .. contents::
  8. :local:
  9. :depth: 2
  10. future.builtins Interface
  11. =========================
  12. .. automodule:: future.builtins
  13. :members:
  14. .. Docs are also in future-builtins.rst. Extract these and put them into the
  15. .. relevant docstrings.
  16. Backported types from Python 3
  17. ==============================
  18. .. automodule:: future.types
  19. :members:
  20. future.standard_library Interface
  21. =================================
  22. .. automodule:: future.standard_library
  23. :members:
  24. future.utils Interface
  25. ======================
  26. .. automodule:: future.utils
  27. :members:
  28. past.builtins Interface
  29. =========================
  30. .. automodule:: past.builtins
  31. :members:
  32. .. Docs are also in future-builtins.rst. Extract these and put them into the
  33. .. relevant docstrings.
  34. Forward-ported types from Python 2
  35. ==================================
  36. .. automodule:: past.types
  37. :members:
  38. .. bytes
  39. .. -----
  40. .. .. automodule:: future.types.newbytes
  41. ..
  42. .. dict
  43. .. -----
  44. .. .. automodule:: future.types.newdict
  45. ..
  46. .. int
  47. .. ---
  48. .. .. automodule:: future.builtins.backports.newint
  49. ..
  50. .. range
  51. .. -----
  52. .. .. automodule:: future.types.newrange
  53. ..
  54. .. str
  55. .. ---
  56. .. .. automodule:: future.types.newstr