wiki:WikiStart

Version 23 (modified by jemian, 10 years ago) (diff)

SpecDomain documentation now hosted on readthedocs.org

BCDA Extensions

This repository contains source for some tools useful at APS beam lines.

project links summary
APSpy docs Support for scripting APS experiments
CssBoyDeploy docs Deploy CSS-BOY at APS beam lines
EpicsDf docs Watch disk space and send email when low
pvMail docs Watch EPICS PV and send email
SoftGlueExamples docs Example circuits and code for the FPGA
SpecDomain docs document SPEC macros using Sphinx
BcdaQWidgets docs EPICS-aware PySide widgets for Python

SpecDomain: software for users to document SPEC macros

list of active tickets

#13
specdomain: create individual topics (pages) for macros when using .. autospecdir::
#15
specdomain: roles should link to directives
#16
specdomain: fix the signature recognition for roles
#17
specdomain: fix the signature handling for roles and directives
#18
specdomain: the out-of-source example PNG shows a Python project, should be a SPEC project
#19
specdomain: add support to document SPEC array declarations
#20
specdomain: layout improvements
#21
specdomain: provide links from each macro to its source code
#22
specdomain: new parser features
#23
specdomain: cdef argument list not handled yet
#24
specdomain: Option to index all symbols in a macro file
#26
specdomain: create a role (or example using a ref) to refer to a macro file from the documentation
#27
specdomain: produce a custom module index with links and summary lines
#28
specdomain: Add option to create separate developer and user versions of the documentation
#29
specdomain: autospecdir and macro file match pattern
#30
specdomain: absolute path names do not show macro source file
#34
specdomain: disable parsing of macro or variable definitions inside extended comments
#39
specdomain: create more meaningful error message when sphinx discovers an invalid char
#60
specdomain: change packaging to setuptools
#61
specdomain: out-of-source build warnings
#62
specdomain: stale URL in documentation
#64
specdomain: re-arrange source code
#65
specdomain: document a complete example using sector 33's macros
#66
specdomain: warnings and errors when building with v1.03


Welcome to Trac 0.10.4

Trac is a minimalistic approach to web-based management of software projects. Its goal is to simplify effective tracking and handling of software issues, enhancements and overall progress.

All aspects of Trac have been designed with the single goal to help developers write great software while staying out of the way and imposing as little as possible on a team's established process and culture.

As all Wiki pages, this page is editable, this means that you can modify the contents of this page simply by using your web-browser. Simply click on the "Edit this page" link at the bottom of the page. WikiFormatting will give you a detailed description of available Wiki formatting commands.

"trac-admin yourenvdir initenv" created a new Trac environment, containing a default set of wiki pages and some sample data. This newly created environment also contains documentation to help you get started with your project.

You can use trac-admin to configure Trac to better fit your project, especially in regard to components, versions and milestones.

TracGuide is a good place to start.

Enjoy!
The Trac Team

Starting Points

For a complete list of local wiki pages, see TitleIndex.