Permalink
Browse files

Renamed documentation folders to represent the online nameing

  developers -> devel
  users -> manual

Added a readme file to the docs folder
Added an API folder placeholder
Updated code/introduction.txt
  • Loading branch information...
daar committed Jan 5, 2018
1 parent 4165079 commit 87cb5a59326ac36ddec9007f30238fd3cec10de5
Showing with 23 additions and 2 deletions.
  1. +13 −0 docs/README.md
  2. +6 −0 docs/api/index.html
  3. +4 −2 docs/code/introduction.txt
  4. 0 docs/{developers → devel}/Makefile
  5. 0 docs/{developers → devel}/make.bat
  6. 0 docs/{developers → devel}/source/about.rst
  7. 0 docs/{developers → devel}/source/architecture/data_layer.rst
  8. 0 docs/{developers → devel}/source/architecture/font.rst
  9. 0 docs/{developers → devel}/source/architecture/general.rst
  10. 0 docs/{developers → devel}/source/architecture/index.rst
  11. 0 docs/{developers → devel}/source/architecture/interface.rst
  12. 0 docs/{developers → devel}/source/architecture/simulation_engine.rst
  13. 0 docs/{developers → devel}/source/architecture/widgets.rst
  14. 0 docs/{developers → devel}/source/coding_standard.rst
  15. 0 docs/{developers → devel}/source/committing_code.rst
  16. 0 docs/{developers → devel}/source/conf.py
  17. 0 docs/{developers → devel}/source/index.rst
  18. 0 docs/{developers → devel}/source/installing_dev_environment.rst
  19. 0 docs/{developers → devel}/source/media/UI_structures.svg
  20. 0 docs/{developers → devel}/source/media/architecture.svg
  21. BIN docs/{developers → devel}/source/media/image1.jpeg
  22. BIN docs/{developers → devel}/source/media/image10.jpeg
  23. BIN docs/{developers → devel}/source/media/image11.jpeg
  24. BIN docs/{developers → devel}/source/media/image12.jpeg
  25. BIN docs/{developers → devel}/source/media/image13.jpeg
  26. BIN docs/{developers → devel}/source/media/image14.jpeg
  27. BIN docs/{developers → devel}/source/media/image15.jpeg
  28. BIN docs/{developers → devel}/source/media/image16.jpeg
  29. BIN docs/{developers → devel}/source/media/image17.jpeg
  30. BIN docs/{developers → devel}/source/media/image18.jpeg
  31. BIN docs/{developers → devel}/source/media/image19.jpeg
  32. BIN docs/{developers → devel}/source/media/image2.jpeg
  33. BIN docs/{developers → devel}/source/media/image20.jpeg
  34. BIN docs/{developers → devel}/source/media/image21.jpeg
  35. BIN docs/{developers → devel}/source/media/image22.jpeg
  36. BIN docs/{developers → devel}/source/media/image23.jpeg
  37. BIN docs/{developers → devel}/source/media/image3.jpeg
  38. BIN docs/{developers → devel}/source/media/image4.jpeg
  39. BIN docs/{developers → devel}/source/media/image5.jpeg
  40. BIN docs/{developers → devel}/source/media/image6.jpeg
  41. BIN docs/{developers → devel}/source/media/image7.jpeg
  42. BIN docs/{developers → devel}/source/media/image8.jpeg
  43. BIN docs/{developers → devel}/source/media/image9.jpeg
  44. 0 docs/{developers → devel}/source/pp_library.rst
  45. 0 docs/{developers → devel}/source/release_cycle.rst
  46. 0 docs/{developers → devel}/source/specifications.rst
  47. 0 docs/{developers → devel}/source/tools.rst
  48. 0 docs/{users → manual}/Makefile
  49. 0 docs/{users → manual}/make.bat
  50. 0 docs/{users → manual}/source/adding_a_model.rst
  51. 0 docs/{users → manual}/source/conf.py
  52. 0 docs/{users → manual}/source/flowsheet_editor.rst
  53. 0 docs/{users → manual}/source/getting_started/about_opsim.rst
  54. 0 docs/{users → manual}/source/getting_started/help.rst
  55. 0 docs/{users → manual}/source/getting_started/index.rst
  56. 0 docs/{users → manual}/source/getting_started/installing_opsim.rst
  57. 0 docs/{users → manual}/source/getting_started/quickstart.rst
  58. 0 docs/{users → manual}/source/index.rst
  59. 0 docs/{users → manual}/source/interface.rst
  60. 0 docs/{users → manual}/source/physical_properties.rst
  61. 0 docs/{users → manual}/source/solver.rst
  62. 0 docs/{users → manual}/source/unit_converter.rst
  63. 0 docs/{users → manual}/source/user_preferences.rst
View
@@ -0,0 +1,13 @@
This folder contains the OpSim documentation. Currently the following documentation is maintained.
code
----
This is the code reference used specifically for developers of OpSim.
devel
-----
This is the developers manual for OpSim. In this manual the conventions and work-flows are described that can be used by developers of the OpSim application.
manual
------
This is the reference reference for users of OpSim. In this manual the functions and features of OpSim are described.
View
@@ -0,0 +1,6 @@
<html>
<header><title>OpSim API reference</title></header>
<body>
Sorry, but nothing to be found here yet. Once scripting will be implemented the API documentation will be made available here.
</body>
</html>
@@ -1,4 +1,6 @@
@shorttitle(Overview)
@title(OpSim code documentation v0.01)
@title(OpSim code documentation v0.02)
This is the documentation of the opsim sources, intended for opsim developers. The developers handbook, where additional information can be found on the internals of opsim is located at http://www.opsim.cc/dev-docs/html. For user's documentation see http://www.opsim.cc/user-docs/html.
This is the code documentation of the OpSim sources, intended for OpSim developers. The developers handbook, where additional information can be found on the internals of OpSim is located at http://docs.opsim.cc/devel.
A users reference manual is available at http://docs.opsim.cc/manual. In this manual the functions and features of OpSim are described. Once scripting is implemented an API reference manual will be available at http://docs.opsim.cc/api.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 87cb5a5

Please sign in to comment.